kinlane
8/17/2018 - 12:55 AM
Kentico Cloud OpenAPI
Kentico Cloud OpenAPI
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Kentico Cloud",
"description": "This is a collection of resources you can find within the [Kentico Cloud Developer Hub](https://developer.kenticocloud.com/). [Kentico Cloud](https://kenticocloud.com/) is a cloud-first headless CMS that allows you to distribute content to any channel and device (websites, mobile devices, mixed reality devices, presentation kiosks etc.) through an API.\n\nCertain APIs require that you include the `authorization` header. Find more in <https://developer.kenticocloud.com/reference#authentication>."
},
"host": "deliver.kenticocloud.com",
"basePath": "/",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/975bf280-fd91-488c-994c-2f04416e5ee3/items": {
"get": {
"description": "Filter the content items by content type by including the `order` query parameter and a content element codename.",
"summary": "Order articles by publish date",
"tags": [
"Getting titles and images of 5 latest articles"
],
"operationId": "975bf280Fd91488c994c2f04416e5ee3ItemsGet8",
"produces": [
"application/json"
],
"parameters": [
{
"name": "system.type",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "order",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/975bf280-fd91-488c-994c-2f04416e5ee3/items?system.type=article&order=elements.post_date[desc]",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Order articles by publish date",
"x-testDescription": "Filter the content items by content type by including the `order` query parameter and a content element codename."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5": {
"get": {
"description": "Retrieve metadata information about a content item specified by its internal ID.",
"summary": "View a content item by ID",
"tags": [
"Content item by ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a content item by ID",
"x-testDescription": "Retrieve metadata information about a content item specified by its internal ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Update an existing content item specified by its internal ID.",
"summary": "Update a content item by ID",
"tags": [
"Content item by ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5Put",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a content item by ID",
"x-testDescription": "Update an existing content item specified by its internal ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a content item specified by its internal ID. Note that deleting a content item deletes all of its language variants as well.",
"summary": "Delete a content item by ID",
"tags": [
"Content item by external ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5Delete2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a content item by ID",
"x-testDescription": "Delete a content item specified by its internal ID. Note that deleting a content item deletes all of its language variants as well."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/14372844-0a5d-434a-8423-605b8a631623/items": {
"get": {
"description": "Filter content items directly in the API call using the `element.element_codename` query parameter and *publish from* and *publish until* elements.\n\nSee <https://developer.kenticocloud.com/docs/scheduling-content-unpublishing#section-filtering-by-date-with-the-delivery-api> for more details.",
"summary": "Filtering based on date with Delivery API",
"tags": [
"Scheduling content unpublishing"
],
"operationId": "143728440a5d434a8423605b8a631623ItemsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "system.type",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "elements.publish_until[gt]",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/14372844-0a5d-434a-8423-605b8a631623/items?system.type=article&elements.publish_until[gt]=2018-10-19T14:57:14",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Filtering based on date with Delivery API",
"x-testDescription": "Filter content items directly in the API call using the `element.element_codename` query parameter and *publish from* and *publish until* elements.\n\nSee <https://developer.kenticocloud.com/docs/scheduling-content-unpublishing#section-filtering-by-date-with-the-delivery-api> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/codename/on_roasts": {
"get": {
"description": "Retrieve metadata information about a content item specified by its codename.",
"summary": "View a content item by codename",
"tags": [
"Content item by codename"
],
"operationId": "ItemsCodenameOnRoastsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/codename/on_roasts",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a content item by codename",
"x-testDescription": "Retrieve metadata information about a content item specified by its codename."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Update an existing content item specified by its codename.",
"summary": "Update a content item by codename",
"tags": [
"Content item by codename"
],
"operationId": "ItemsCodenameOnRoastsPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/codename/on_roasts",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a content item by codename",
"x-testDescription": "Update an existing content item specified by its codename."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a content item specified by its codename.\n\nNote that deleting a content item deletes all of its language variants as well.",
"summary": "Delete a content item by codename",
"tags": [
"Content item by codename"
],
"operationId": "ItemsCodenameOnRoastsDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/items/codename/on_roasts",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a content item by codename",
"x-testDescription": "Delete a content item specified by its codename.\n\nNote that deleting a content item deletes all of its language variants as well."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants/codename/en-US": {
"get": {
"description": "Retrieve content of a variant of a content item. The content item is specified by its internal ID and the project language is specified by its codename.",
"summary": "View a language variant by language codename",
"tags": [
"Language variant by ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5VariantsCodenameEnUSGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants/codename/en-US",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a language variant by language codename",
"x-testDescription": "Retrieve content of a variant of a content item. The content item is specified by its internal ID and the project language is specified by its codename."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Add content to a variant in an active project language, or update an existing language variant. The content item is specified by its internal ID and the project language is specified by its codename.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update.",
"summary": "Upsert a variant by language codename",
"tags": [
"Language variant by ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5VariantsCodenameEnUSPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpsertAVariantByLanguageCodenamerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants/codename/en-US",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"elements\":{\"personas\":[{\"codename\":\"barista\"},{\"codename\":\"coffee_blogger\"}],\"title\":\"En Asados\",\"post_date\":\"2014-11-07T00:00:00Z\",\"summary\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"related_articles\":[{\"codename\":\"coffee_processing_techniques\"},{\"codename\":\"origins_of_arabica_bourbon\"}],\"meta_keywords\":\"asados, café\",\"meta_description\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"url_pattern\":\"on-roasts\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upsert a variant by language codename",
"x-testDescription": "Add content to a variant in an active project language, or update an existing language variant. The content item is specified by its internal ID and the project language is specified by its codename.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a specific language variant. The content item is specified by its external ID and the project language is specified by its codename.\r\n\r\nNote that when you delete the last variant of a content item, the whole content item is deleted.",
"summary": "Delete a variant by language codename",
"tags": [
"Language variant by external ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5VariantsCodenameEnUSDelete3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants/codename/en-US",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a variant by language codename",
"x-testDescription": "Delete a specific language variant. The content item is specified by its external ID and the project language is specified by its codename.\r\n\r\nNote that when you delete the last variant of a content item, the whole content item is deleted."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/external-id/ext-cafe-brno-59713/variants/codename/en-US": {
"put": {
"description": "Add content in a specific language to your new content item by performing an upsert.\r\n\r\n* In the request URL, you need to specify the content item you are importing to (for example, `/items/external-id/ext-cafe-brno-59713`) and the language of the variant (for example, `/variants/codename/en-US`).\r\n* The request body must contain the `elements` object in which you specify only the content elements you want to update. Omitted elements will remain unchanged.\r\n\r\nSee <https://developer.kenticocloud.com/docs/importing-to-kentico-cloud#section-2-adding-localized-content> for more details.",
"summary": "Adding localized content",
"tags": [
"Importing to Kentico Cloud"
],
"operationId": "ItemsExternalIdExtCafeBrno59713VariantsCodenameEnUSPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddingLocalizedContentrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/external-id/ext-cafe-brno-59713/variants/codename/en-US",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"elements\":{\"street\":\"Nove Sady 25\",\"city\":\"Brno\",\"country\":\"Czech Republic\",\"state\":\"Jihomoravsky kraj\",\"zip_code\":\"60200\",\"phone\":\"+420 444 444 444\",\"email\":\"brnocafe@kentico.com\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Adding localized content",
"x-testDescription": "Add content in a specific language to your new content item by performing an upsert.\r\n\r\n* In the request URL, you need to specify the content item you are importing to (for example, `/items/external-id/ext-cafe-brno-59713`) and the language of the variant (for example, `/variants/codename/en-US`).\r\n* The request body must contain the `elements` object in which you specify only the content elements you want to update. Omitted elements will remain unchanged.\r\n\r\nSee <https://developer.kenticocloud.com/docs/importing-to-kentico-cloud#section-2-adding-localized-content> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/visitor/569030c7-52a5-44f5-a243-c5285b3eb24e/7888c9a3824a11f1/segments": {
"get": {
"description": "Retrieve the names of segments that the specified visitor belongs to.",
"summary": "List segments of a visitor",
"tags": [
"Personalization API v3"
],
"operationId": "Visitor569030c752a544f5A243C5285b3eb24e7888c9a3824a11f1SegmentsGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/visitor/569030c7-52a5-44f5-a243-c5285b3eb24e/7888c9a3824a11f1/segments"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List segments of a visitor",
"x-testDescription": "Retrieve the names of segments that the specified visitor belongs to."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/external-id/ext-cafe-brno-59713": {
"put": {
"description": "One of the ways to import content to your project is to send a PUT request to the `<cmApiUrl>/items/external-id/<your item ID>` endpoint.\r\n\r\nIn the body of the request, specify these properties:\r\n\r\n* `name` – string with a display name of the new content item.\r\n* `type` – reference to a content type.\r\n* (Optional) `sitemap_locations` – array of references to sitemap locations.\r\n\r\nSee <https://developer.kenticocloud.com/docs/importing-to-kentico-cloud#section-1-creating-a-content-item> for more details.",
"summary": "Creating a content item",
"tags": [
"Importing to Kentico Cloud"
],
"operationId": "ItemsExternalIdExtCafeBrno59713Put",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreatingAContentItemrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/external-id/ext-cafe-brno-59713",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"name\":\"Brno\",\"type\":{\"codename\":\"cafe\"},\"sitemap_locations\":[{\"codename\":\"cafes\"},{\"codename\":\"europe\"}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Creating a content item",
"x-testDescription": "One of the ways to import content to your project is to send a PUT request to the `<cmApiUrl>/items/external-id/<your item ID>` endpoint.\r\n\r\nIn the body of the request, specify these properties:\r\n\r\n* `name` – string with a display name of the new content item.\r\n* `type` – reference to a content type.\r\n* (Optional) `sitemap_locations` – array of references to sitemap locations.\r\n\r\nSee <https://developer.kenticocloud.com/docs/importing-to-kentico-cloud#section-1-creating-a-content-item> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants/00000000-0000-0000-0000-000000000000": {
"get": {
"description": "Retrieve content of a language variant of a content item. Both the content item and the project language are specified by their internal IDs.",
"summary": "View a language variant by language ID",
"tags": [
"Language variant by ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5Variants00000000000000000000000000000000Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a language variant by language ID",
"x-testDescription": "Retrieve content of a language variant of a content item. Both the content item and the project language are specified by their internal IDs."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Add content to a variant in an active project language, or update an existing language variant. Both the content item and project language are specified by their internal IDs.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update.",
"summary": "Upsert a variant by language ID",
"tags": [
"Language variant by ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5Variants00000000000000000000000000000000Put",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpsertAVariantByLanguageIdrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"elements\":{\"personas\":[{\"codename\":\"barista\"},{\"codename\":\"coffee_blogger\"}],\"title\":\"En Asados\",\"post_date\":\"2014-11-07T00:00:00Z\",\"summary\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"related_articles\":[{\"codename\":\"coffee_processing_techniques\"},{\"codename\":\"origins_of_arabica_bourbon\"}],\"meta_keywords\":\"asados, café\",\"meta_description\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"url_pattern\":\"on-roasts\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upsert a variant by language ID",
"x-testDescription": "Add content to a variant in an active project language, or update an existing language variant. Both the content item and project language are specified by their internal IDs.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a specific language variant. Both the content item and the project language are specified by their internal IDs.\r\n\r\nNote that when you delete the last variant of a content item, the whole content item is deleted.",
"summary": "Delete a variant by language ID",
"tags": [
"Language variant by ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5Variants00000000000000000000000000000000Delete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a variant by language ID",
"x-testDescription": "Delete a specific language variant. Both the content item and the project language are specified by their internal IDs.\r\n\r\nNote that when you delete the last variant of a content item, the whole content item is deleted."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/assets/external-id/which-brewing-fits-you": {
"get": {
"description": "Retrieve information about a single asset specified by its external ID.",
"summary": "View an asset by external ID",
"tags": [
"Asset by external ID"
],
"operationId": "AssetsExternalIdWhichBrewingFitsYouGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/assets/external-id/which-brewing-fits-you",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View an asset by external ID",
"x-testDescription": "Retrieve information about a single asset specified by its external ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Add a new asset or update an existing asset specified by its external ID.\r\n\r\n**Note:** If no asset with the specified external ID exists in the project, the system will try to create one. For existing assets, the API updates only the specified asset's descriptions and title.",
"summary": "Upsert an asset by external ID",
"tags": [
"Asset by external ID"
],
"operationId": "AssetsExternalIdWhichBrewingFitsYouPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpsertAnAssetByExternalIdrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/assets/external-id/which-brewing-fits-you",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"file_reference\":{\"id\":\"fcbb12e6-66a3-4672-85d9-d502d16b8d9c\",\"type\":\"internal\"},\"title\":\"Coffe Brewing Techniques\",\"descriptions\":[{\"language\":{\"codename\":\"en-US\"},\"description\":\"Coffee Brewing Techniques\"},{\"language\":{\"codename\":\"es-ES\"},\"description\":\"Técnicas para hacer café\"}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upsert an asset by external ID",
"x-testDescription": "Add a new asset or update an existing asset specified by its external ID.\r\n\r\n**Note:** If no asset with the specified external ID exists in the project, the system will try to create one. For existing assets, the API updates only the specified asset's descriptions and title."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Removes an unused asset specified by its external ID.",
"summary": "Delete an asset by ID",
"tags": [
"Asset by external ID"
],
"operationId": "AssetsExternalIdWhichBrewingFitsYouDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/assets/external-id/which-brewing-fits-you",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete an asset by ID",
"x-testDescription": "Removes an unused asset specified by its external ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/assets": {
"get": {
"description": "Retrieve a dynamically paginated list of assets.",
"summary": "List assets",
"tags": [
"Content Management API"
],
"operationId": "AssetsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/assets",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List assets",
"x-testDescription": "Retrieve a dynamically paginated list of assets."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Use a file reference to link an existing [binary file](https://developer.kenticocloud.com/v1/reference#content-management-api-upload-file) to a new asset. You can also create assets by upserting (`PUT /assets/external-id/<external_id>`), see [Upsert an asset](https://developer.kenticocloud.com/v1/reference#content-management-api-upsert-asset-by-external-id).\r\n\r\n**Note:** Each binary file can be referenced only by a single asset.",
"summary": "Add an asset",
"tags": [
"Content Management API"
],
"operationId": "AssetsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddAnAssetrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/assets",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"file_reference\":{\"id\":\"fcbb12e6-66a3-4672-85d9-d502d16b8d9c\",\"type\":\"internal\"},\"title\":\"Coffee Brewing Techniques\",\"external_id\":\"which-brewing-fits-you\",\"descriptions\":[{\"language\":{\"codename\":\"en-US\"},\"description\":\"Coffee Brewing Techniques\"},{\"language\":{\"codename\":\"es-ES\"},\"description\":\"Técnicas para hacer café\"}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Add an asset",
"x-testDescription": "Use a file reference to link an existing [binary file](https://developer.kenticocloud.com/v1/reference#content-management-api-upload-file) to a new asset. You can also create assets by upserting (`PUT /assets/external-id/<external_id>`), see [Upsert an asset](https://developer.kenticocloud.com/v1/reference#content-management-api-upsert-asset-by-external-id).\r\n\r\n**Note:** Each binary file can be referenced only by a single asset."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/8d155914-6674-4f17-8104-3b1c5c2b37e4/items/partner_promotion": {
"get": {
"description": "Retrieve one personalization variant you want to display. To learn more about retrieving content, consult the [Delivery API reference](https://developer.kenticocloud.com/reference#delivery-api).\n\nSee <https://developer.kenticocloud.com/docs/personalizing-content#section-displaying-the-right-content> for more examples.",
"summary": "Displaying the right content",
"tags": [
"Personalizing content"
],
"operationId": "8d15591466744f1781043b1c5c2b37e4ItemsPartnerPromotionGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/8d155914-6674-4f17-8104-3b1c5c2b37e4/items/partner_promotion",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Displaying the right content",
"x-testDescription": "Retrieve one personalization variant you want to display. To learn more about retrieving content, consult the [Delivery API reference](https://developer.kenticocloud.com/reference#delivery-api).\n\nSee <https://developer.kenticocloud.com/docs/personalizing-content#section-displaying-the-right-content> for more examples."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/assets/fcbb12e6-66a3-4672-85d9-d502d16b8d9c": {
"get": {
"description": "Modifies properties of an asset specified by its internal ID.\r\n\r\nNote: This endpoint only allows updating of asset descriptions and title.",
"summary": "View an asset by ID",
"tags": [
"Asset by ID"
],
"operationId": "AssetsFcbb12e666a3467285d9D502d16b8d9cGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/assets/fcbb12e6-66a3-4672-85d9-d502d16b8d9c",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View an asset by ID",
"x-testDescription": "Modifies properties of an asset specified by its internal ID.\r\n\r\nNote: This endpoint only allows updating of asset descriptions and title."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Retrieve a dynamically paginated list of assets.",
"summary": "Update an asset by ID",
"tags": [
"Asset by ID"
],
"operationId": "AssetsFcbb12e666a3467285d9D502d16b8d9cPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAnAssetByIdrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/assets/fcbb12e6-66a3-4672-85d9-d502d16b8d9c",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"title\":\"Coffe Brewing Techniques\",\"descriptions\":[{\"language\":{\"codename\":\"en-US\"},\"description\":\"Coffee Brewing Techniques\"},{\"language\":{\"codename\":\"es-ES\"},\"description\":\"Técnicas para hacer café\"}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update an asset by ID",
"x-testDescription": "Retrieve a dynamically paginated list of assets."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Removes an unused asset specified by its internal ID.",
"summary": "Delete an asset by ID",
"tags": [
"Asset by ID"
],
"operationId": "AssetsFcbb12e666a3467285d9D502d16b8d9cDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/assets/fcbb12e6-66a3-4672-85d9-d502d16b8d9c",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete an asset by ID",
"x-testDescription": "Removes an unused asset specified by its internal ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/external-id/59713/variants/00000000-0000-0000-0000-000000000000": {
"get": {
"description": "Retrieve content of a variant of a content item. The content item is specified by its external ID and the project language is specified by its internal ID.",
"summary": "View a language variant by language ID",
"tags": [
"Language variant by external ID"
],
"operationId": "ItemsExternalId59713Variants00000000000000000000000000000000Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/external-id/59713/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a language variant by language ID",
"x-testDescription": "Retrieve content of a variant of a content item. The content item is specified by its external ID and the project language is specified by its internal ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Add content to a variant in an active project language, or update an existing language variant. The content item is specified by its external ID and the project language is specified by its internal ID.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update.",
"summary": "Upsert a variant by language ID",
"tags": [
"Language variant by external ID"
],
"operationId": "ItemsExternalId59713Variants00000000000000000000000000000000Put",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpsertAVariantByLanguageIdrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/external-id/59713/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"elements\":{\"personas\":[{\"codename\":\"barista\"},{\"codename\":\"coffee_blogger\"}],\"title\":\"En Asados\",\"post_date\":\"2014-11-07T00:00:00Z\",\"summary\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"related_articles\":[{\"codename\":\"coffee_processing_techniques\"},{\"codename\":\"origins_of_arabica_bourbon\"}],\"meta_keywords\":\"asados, café\",\"meta_description\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"url_pattern\":\"on-roasts\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upsert a variant by language ID",
"x-testDescription": "Add content to a variant in an active project language, or update an existing language variant. The content item is specified by its external ID and the project language is specified by its internal ID.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a specific language variant. The content item is specified by its external ID and the project language is specified by its internal ID.\r\n\r\nNote that when you delete the last variant of a content item, the whole content item is deleted.",
"summary": "Delete a variant by language ID",
"tags": [
"Language variant by external ID"
],
"operationId": "ItemsExternalId59713Variants00000000000000000000000000000000Delete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/items/external-id/59713/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a variant by language ID",
"x-testDescription": "Delete a specific language variant. The content item is specified by its external ID and the project language is specified by its internal ID.\r\n\r\nNote that when you delete the last variant of a content item, the whole content item is deleted."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/external-id/59713/variants/codename/en-US": {
"get": {
"description": "Retrieve content of a variant of a content item. The content item is specified by its external ID and the project language is specified by its codename.",
"summary": "View a language variant by language codename",
"tags": [
"Language variant by external ID"
],
"operationId": "ItemsExternalId59713VariantsCodenameEnUSGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/external-id/59713/variants/codename/en-US",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a language variant by language codename",
"x-testDescription": "Retrieve content of a variant of a content item. The content item is specified by its external ID and the project language is specified by its codename."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Add content to a variant in an active project language, or update an existing language variant. The content item is specified by its external ID and the project language is specified by its codename.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update.",
"summary": "Upsert a variant by language codename",
"tags": [
"Language variant by external ID"
],
"operationId": "ItemsExternalId59713VariantsCodenameEnUSPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpsertAVariantByLanguageCodenamerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/external-id/59713/variants/codename/en-US",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"elements\":{\"personas\":[{\"codename\":\"barista\"},{\"codename\":\"coffee_blogger\"}],\"title\":\"En Asados\",\"post_date\":\"2014-11-07T00:00:00Z\",\"summary\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"related_articles\":[{\"codename\":\"coffee_processing_techniques\"},{\"codename\":\"origins_of_arabica_bourbon\"}],\"meta_keywords\":\"asados, café\",\"meta_description\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"url_pattern\":\"on-roasts\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upsert a variant by language codename",
"x-testDescription": "Add content to a variant in an active project language, or update an existing language variant. The content item is specified by its external ID and the project language is specified by its codename.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/contact": {
"post": {
"description": "Submit the visitor's email address and other information.",
"summary": "Create a contact profile",
"tags": [
"Tracking API"
],
"operationId": "ContactPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAContactProfilerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/contact",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"uid\":\"7888c9a3824a11f1\",\"sid\":\"111114cc62300000\",\"email\":\"john.snow@wall.north\",\"name\":\"John Snow\",\"company\":\"Night's Watch\",\"phone\":\"444-256-487\",\"website\":\"http://gameofthrones.wikia.com/wiki/Jon_Snow\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a contact profile",
"x-testDescription": "Submit the visitor's email address and other information."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/activity": {
"post": {
"description": "Log a custom action for a specified visitor.",
"summary": "Record a custom activity",
"tags": [
"Tracking API"
],
"operationId": "ActivityPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/RecordACustomActivityrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/activity",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"uid\":\"7888c9a3824a11f1\",\"sid\":\"111114cc62300000\",\"codename\":\"Clicked_facebook_icon\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Record a custom activity",
"x-testDescription": "Log a custom action for a specified visitor."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/session": {
"post": {
"description": "Log a new session for a specified visitor.",
"summary": "Record a new session",
"tags": [
"Tracking API"
],
"operationId": "SessionPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/RecordANewSessionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/session",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"uid\":\"{{UserId}}\",\"sid\":\"111114cc62300000\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Record a new session",
"x-testDescription": "Log a new session for a specified visitor."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/975bf280-fd91-488c-994c-2f04416e5ee3/items/on_roasts": {
"get": {
"description": "Get a content item in a specific language variant by using the `language` parameter.\n\nSee [Getting localized content items](https://developer.kenticocloud.com/docs/localization#section-getting-localized-content-items) for more details.",
"summary": "Getting localized content items",
"tags": [
"Localized content"
],
"operationId": "975bf280Fd91488c994c2f04416e5ee3ItemsOnRoastsGet3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "language",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/975bf280-fd91-488c-994c-2f04416e5ee3/items/on_roasts?language=es-ES",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Getting localized content items",
"x-testDescription": "Get a content item in a specific language variant by using the `language` parameter.\n\nSee [Getting localized content items](https://developer.kenticocloud.com/docs/localization#section-getting-localized-content-items) for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/external-id/59713": {
"get": {
"description": "Retrieve metadata information about a content item specified by its external ID.",
"summary": "View a content Item by external ID",
"tags": [
"Content item by external ID"
],
"operationId": "ItemsExternalId59713Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/external-id/59713",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a content Item by external ID",
"x-testDescription": "Retrieve metadata information about a content item specified by its external ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Add a new content item or update an existing content item specified by its external ID.\r\n\r\n**Note:** If no content item with the specified external ID exists in the project, the system will try to create one. For existing content items, the API updates the content item's name and sitemap locations.\r\nYou can also specify the external ID when [adding content items](https://developer.kenticocloud.com/v1/reference#content-management-api-add-item) via the POST method.",
"summary": "Update a content item by external ID",
"tags": [
"Content item by external ID"
],
"operationId": "ItemsExternalId59713Put",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/external-id/59713",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a content item by external ID",
"x-testDescription": "Add a new content item or update an existing content item specified by its external ID.\r\n\r\n**Note:** If no content item with the specified external ID exists in the project, the system will try to create one. For existing content items, the API updates the content item's name and sitemap locations.\r\nYou can also specify the external ID when [adding content items](https://developer.kenticocloud.com/v1/reference#content-management-api-add-item) via the POST method."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/codename/on_roasts/variants": {
"get": {
"description": "Retrieve a list of language variants of a content item specified by its codename.",
"summary": "List language variants",
"tags": [
"Language variant by codename"
],
"operationId": "ItemsCodenameOnRoastsVariantsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/codename/on_roasts/variants",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List language variants",
"x-testDescription": "Retrieve a list of language variants of a content item specified by its codename."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/975bf280-fd91-488c-994c-2f04416e5ee3/taxonomies/personas": {
"get": {
"description": "Retrieve a specific taxonomy group from your project by specifying its codename.\n\nSee <https://developer.kenticocloud.com/v1/reference#view-a-taxonomy-group> for more details.",
"summary": "View a taxonomy group",
"tags": [
"Delivery API"
],
"operationId": "975bf280Fd91488c994c2f04416e5ee3TaxonomiesPersonasGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/975bf280-fd91-488c-994c-2f04416e5ee3/taxonomies/personas",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a taxonomy group",
"x-testDescription": "Retrieve a specific taxonomy group from your project by specifying its codename.\n\nSee <https://developer.kenticocloud.com/v1/reference#view-a-taxonomy-group> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/uid/7888c9a3824a11f1": {
"get": {
"description": "",
"summary": "View data of visitor by ID",
"tags": [
"Personal Data API"
],
"operationId": "Uid7888c9a3824a11f1Get",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/uid/7888c9a3824a11f1"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View data of visitor by ID",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete data of visitor by ID",
"tags": [
"Personal Data API"
],
"operationId": "Uid7888c9a3824a11f1Delete",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/uid/7888c9a3824a11f1"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete data of visitor by ID",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants": {
"get": {
"description": "Retrieve a list of language variants of a content item specified by its internal ID.",
"summary": "List language variants",
"tags": [
"Language variant by ID"
],
"operationId": "Items3120ec15A4a247ec8ccdC85ac8ac5ba5VariantsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5/variants",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List language variants",
"x-testDescription": "Retrieve a list of language variants of a content item specified by its internal ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/975bf280-fd91-488c-994c-2f04416e5ee3/types/coffee": {
"get": {
"description": "Retrieve a specific content type from your project by specifying its codename.\n\nSee <https://developer.kenticocloud.com/v1/reference#view-a-content-type> for more details.",
"summary": "View a content type",
"tags": [
"Delivery API"
],
"operationId": "975bf280Fd91488c994c2f04416e5ee3TypesCoffeeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/975bf280-fd91-488c-994c-2f04416e5ee3/types/coffee",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a content type",
"x-testDescription": "Retrieve a specific content type from your project by specifying its codename.\n\nSee <https://developer.kenticocloud.com/v1/reference#view-a-content-type> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/segment/569030c7-52a5-44f5-a243-c5285b3eb24e/{SegmentName}/visitors": {
"get": {
"description": "Retrieve visitors that match the specified segment.",
"summary": "List visitors of a segment",
"tags": [
"Personalization API v3"
],
"operationId": "Segment569030c752a544f5A243C5285b3eb24eVisitorsBySegmentNameGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "SegmentName",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items": {
"get": {
"description": "Retrieve a dynamically paginated list of content items.",
"summary": "List content items",
"tags": [
"Content Management API"
],
"operationId": "ItemsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List content items",
"x-testDescription": "Retrieve a dynamically paginated list of content items."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Create a new content item based on a specific content type. Content items do NOT contain any content themselves, but serve as wrappers for individual language variants.\n\nSee <https://developer.kenticocloud.com/v1/reference#content-management-api-add-item> for details about adding content to a specific language variant.\n\nIf you are importing content from a different system and want to use the same identifiers for your content as in the previous system, you can use the `external_id` body attribute to set a custom identifier for the new content item.",
"summary": "Add a content item",
"tags": [
"Content Management API"
],
"operationId": "ItemsPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/items",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Add a content item",
"x-testDescription": "Create a new content item based on a specific content type. Content items do NOT contain any content themselves, but serve as wrappers for individual language variants.\n\nSee <https://developer.kenticocloud.com/v1/reference#content-management-api-add-item> for details about adding content to a specific language variant.\n\nIf you are importing content from a different system and want to use the same identifiers for your content as in the previous system, you can use the `external_id` body attribute to set a custom identifier for the new content item."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/975bf280-fd91-488c-994c-2f04416e5ee3/taxonomies": {
"get": {
"description": "Retrieve a paginated list of taxonomy groups in your project.\n\nBy default, the API returns all taxonomy groups ordered alphabetically by codename, but [pagination can be customized](https://developer.kenticocloud.com/v1/reference#listing-response).\n\nSee <https://developer.kenticocloud.com/v1/reference#list-taxonomy-groups> for more details.",
"summary": "List taxonomy groups",
"tags": [
"Delivery API"
],
"operationId": "975bf280Fd91488c994c2f04416e5ee3TaxonomiesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/975bf280-fd91-488c-994c-2f04416e5ee3/taxonomies",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List taxonomy groups",
"x-testDescription": "Retrieve a paginated list of taxonomy groups in your project.\n\nBy default, the API returns all taxonomy groups ordered alphabetically by codename, but [pagination can be customized](https://developer.kenticocloud.com/v1/reference#listing-response).\n\nSee <https://developer.kenticocloud.com/v1/reference#list-taxonomy-groups> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/visitor/569030c7-52a5-44f5-a243-c5285b3eb24e/e3e9e191a12b9257/segment": {
"get": {
"description": "Use the Personalization API to retrieve the list of segments that the specified visitor belongs to.\n\n* Authenticate the request using your Personalization API Key.\n* Specify the User ID of the visitor you are asking about.\n \nSee <https://developer.kenticocloud.com/docs/personalizing-content#section-retrieving-visitor-s-segments> for more details.",
"summary": "Retrieving visitor's segments",
"tags": [
"Personalizing content"
],
"operationId": "Visitor569030c752a544f5A243C5285b3eb24eE3e9e191a12b9257SegmentGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/visitor/569030c7-52a5-44f5-a243-c5285b3eb24e/e3e9e191a12b9257/segment",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Retrieving visitor's segments",
"x-testDescription": "Use the Personalization API to retrieve the list of segments that the specified visitor belongs to.\n\n* Authenticate the request using your Personalization API Key.\n* Specify the User ID of the visitor you are asking about.\n \nSee <https://developer.kenticocloud.com/docs/personalizing-content#section-retrieving-visitor-s-segments> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/codename/on_roasts/variants/00000000-0000-0000-0000-000000000000": {
"get": {
"description": "Retrieve content of a variant of a content item. The content item is specified by codename and the project language is specified its internal ID.",
"summary": "View a language variant by language ID",
"tags": [
"Language variant by codename"
],
"operationId": "ItemsCodenameOnRoastsVariants00000000000000000000000000000000Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/codename/on_roasts/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a language variant by language ID",
"x-testDescription": "Retrieve content of a variant of a content item. The content item is specified by codename and the project language is specified its internal ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Add content to a variant in an active project language, or update an existing language variant. The content item is specified by its codename and the project language is specified by its internal ID.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update.",
"summary": "Upsert a variant by language ID",
"tags": [
"Language variant by codename"
],
"operationId": "ItemsCodenameOnRoastsVariants00000000000000000000000000000000Put",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpsertAVariantByLanguageIdrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/codename/on_roasts/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"elements\":{\"personas\":[{\"codename\":\"barista\"},{\"codename\":\"coffee_blogger\"}],\"title\":\"En Asados\",\"post_date\":\"2014-11-07T00:00:00Z\",\"summary\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"related_articles\":[{\"codename\":\"coffee_processing_techniques\"},{\"codename\":\"origins_of_arabica_bourbon\"}],\"meta_keywords\":\"asados, café\",\"meta_description\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"url_pattern\":\"on-roasts\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upsert a variant by language ID",
"x-testDescription": "Add content to a variant in an active project language, or update an existing language variant. The content item is specified by its codename and the project language is specified by its internal ID.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a specific language variant. The content item is specified by codename and the project language is specified its internal ID.\r\n\r\nNote that when you delete the last variant of a content item, the whole content item is deleted.",
"summary": "Delete a variant by language ID",
"tags": [
"Language variant by codename"
],
"operationId": "ItemsCodenameOnRoastsVariants00000000000000000000000000000000Delete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/items/codename/on_roasts/variants/00000000-0000-0000-0000-000000000000",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a variant by language ID",
"x-testDescription": "Delete a specific language variant. The content item is specified by codename and the project language is specified its internal ID.\r\n\r\nNote that when you delete the last variant of a content item, the whole content item is deleted."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/975bf280-fd91-488c-994c-2f04416e5ee3/types": {
"get": {
"description": "Retrieve a list of content types in your project.\n\nSee <https://developer.kenticocloud.com/v1/reference#list-content-types> for more details.",
"summary": "List content types",
"tags": [
"Delivery API"
],
"operationId": "975bf280Fd91488c994c2f04416e5ee3TypesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/975bf280-fd91-488c-994c-2f04416e5ee3/types",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List content types",
"x-testDescription": "Retrieve a list of content types in your project.\n\nSee <https://developer.kenticocloud.com/v1/reference#list-content-types> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/codename/on_roasts/variants/codename/en-US": {
"get": {
"description": "Retrieve content of a language variant of a content item. Both the content item and the language are specified by their codenames.",
"summary": "View a language variant by language codename",
"tags": [
"Language variant by codename"
],
"operationId": "ItemsCodenameOnRoastsVariantsCodenameEnUSGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/codename/on_roasts/variants/codename/en-US",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a language variant by language codename",
"x-testDescription": "Retrieve content of a language variant of a content item. Both the content item and the language are specified by their codenames."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Add content to a variant in an active project language, or update an existing language variant. Both the content item and project language are specified by their codenames.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update.",
"summary": "Upsert a variant by language codename",
"tags": [
"Language variant by codename"
],
"operationId": "ItemsCodenameOnRoastsVariantsCodenameEnUSPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpsertAVariantByLanguageCodenamerequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/items/codename/on_roasts/variants/codename/en-US",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"elements\":{\"personas\":[{\"codename\":\"barista\"},{\"codename\":\"coffee_blogger\"}],\"title\":\"En Asados\",\"post_date\":\"2014-11-07T00:00:00Z\",\"summary\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"related_articles\":[{\"codename\":\"coffee_processing_techniques\"},{\"codename\":\"origins_of_arabica_bourbon\"}],\"meta_keywords\":\"asados, café\",\"meta_description\":\"Tostar granos de café puede tardar de 6 a 13 minutos. ...\",\"url_pattern\":\"on-roasts\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upsert a variant by language codename",
"x-testDescription": "Add content to a variant in an active project language, or update an existing language variant. Both the content item and project language are specified by their codenames.\r\n\r\n**Note:** Only the elements specified in the request body will be modified. Any existing comments attached to these elements will be lost on update."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"//": {
"get": {
"description": "Get a *Home* content item whose URL slug in Spanish is *inicio* by using the following parameters:\n\n* `language=es-ES` – specifies the codename of the requested language.\n* `system.type=home` – filters content items by their content type.\n* `elements.url_pattern=inicio` – filters content items by a value of a specific content element.\n\nSee [Getting items by localized URL slug](https://developer.kenticocloud.com/docs/localization#section-getting-items-by-localized-url-slug) for more details.",
"summary": "Getting items by localized URL slug",
"tags": [
"Localized content"
],
"operationId": "UnnammedEndpointGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "//"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Getting items by localized URL slug",
"x-testDescription": "Get a *Home* content item whose URL slug in Spanish is *inicio* by using the following parameters:\n\n* `language=es-ES` – specifies the codename of the requested language.\n* `system.type=home` – filters content items by their content type.\n* `elements.url_pattern=inicio` – filters content items by a value of a specific content element.\n\nSee [Getting items by localized URL slug](https://developer.kenticocloud.com/docs/localization#section-getting-items-by-localized-url-slug) for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/validate": {
"post": {
"description": "Check your project's content items for issues, such as:\r\n\r\n* Content elements are [referencing](https://developer.kenticocloud.com/v1/reference#content-management-api-reference-object) non-existing objects.\r\n* Values of certain content elements do not meet the limitations set in content types.\r\n\r\nUse the endpoint after successfully importing content to your project.",
"summary": "Validate project content",
"tags": [
"Content Management API"
],
"operationId": "ValidatePost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/validate",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Validate project content",
"x-testDescription": "Check your project's content items for issues, such as:\r\n\r\n* Content elements are [referencing](https://developer.kenticocloud.com/v1/reference#content-management-api-reference-object) non-existing objects.\r\n* Values of certain content elements do not meet the limitations set in content types.\r\n\r\nUse the endpoint after successfully importing content to your project."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/items/external-id/59713/variants": {
"get": {
"description": "Retrieve a list of language variants of a content item specified by its external ID.",
"summary": "List language variants",
"tags": [
"Language variant by external ID"
],
"operationId": "ItemsExternalId59713VariantsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/items/external-id/59713/variants",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List language variants",
"x-testDescription": "Retrieve a list of language variants of a content item specified by its external ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/email/lola.mira@blabla.com": {
"get": {
"description": "",
"summary": "View data of visitor by email",
"tags": [
"Personal Data API"
],
"operationId": "EmailLolaMiraBlablaComGet",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/email/lola.mira@blabla.com"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View data of visitor by email",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete data of visitor by email",
"tags": [
"Personal Data API"
],
"operationId": "EmailLolaMiraBlablaComDelete",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/email/lola.mira@blabla.com"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete data of visitor by email",
"x-testDescription": ""
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/files/which-brewing-fits-you-1080px.jpg": {
"post": {
"description": "Add a new file. The uploaded file will not be visible in the Kentico Cloud UI unless there is an asset using it, see how to [add an asset](https://developer.kenticocloud.com/v1/reference#content-management-api-add-asset).\r\n\r\n**Note:** Maximum size limit for binary files is 100 MB.",
"summary": "Upload a binary file",
"tags": [
"Content Management API"
],
"operationId": "FilesWhichBrewingFitsYou1080pxJpgPost",
"produces": [
"application/json"
],
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "File",
"in": "formData",
"required": true,
"type": "file",
"format": "file",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": "Specifies the media type of the binary data. Example: image/jpeg, application/zip."
},
{
"name": "Content-Length",
"in": "header",
"required": true,
"type": "string",
"description": "Specifies the size of the binary file in bytes. Example: 125770."
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/which_brewing_fits_you_": {
"get": {
"description": "Preview a specific content item.\n\nSee <https://developer.kenticocloud.com/docs/preview-content-via-api> for details.",
"summary": "Previewing an article",
"tags": [
"Previewing content via API"
],
"operationId": "WhichBrewingFitsYouGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/which_brewing_fits_you_",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Previewing an article",
"x-testDescription": "Preview a specific content item.\n\nSee <https://developer.kenticocloud.com/docs/preview-content-via-api> for details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/975bf280-fd91-488c-994c-2f04416e5ee3/types/coffee/elements/processing": {
"get": {
"description": "Retrieve a specific content type element by specifying its codename and its parent content type.\n\nSee <https://developer.kenticocloud.com/v1/reference#view-a-content-type-element> for more details.",
"summary": "View a content type element",
"tags": [
"Delivery API"
],
"operationId": "975bf280Fd91488c994c2f04416e5ee3TypesCoffeeElementsProcessingGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/975bf280-fd91-488c-994c-2f04416e5ee3/types/coffee/elements/processing",
"headers": {
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "View a content type element",
"x-testDescription": "Retrieve a specific content type element by specifying its codename and its parent content type.\n\nSee <https://developer.kenticocloud.com/v1/reference#view-a-content-type-element> for more details."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"AddingLocalizedContentrequest": {
"title": "Adding localized contentRequest",
"example": {
"elements": {
"street": "Nove Sady 25",
"city": "Brno",
"country": "Czech Republic",
"state": "Jihomoravsky kraj",
"zip_code": "60200",
"phone": "+420 444 444 444",
"email": "brnocafe@kentico.com"
}
},
"type": "object",
"properties": {
"elements": {
"$ref": "#/definitions/Elements"
}
},
"required": [
"elements"
]
},
"Elements": {
"title": "Elements",
"example": {
"street": "Nove Sady 25",
"city": "Brno",
"country": "Czech Republic",
"state": "Jihomoravsky kraj",
"zip_code": "60200",
"phone": "+420 444 444 444",
"email": "brnocafe@kentico.com"
},
"type": "object",
"properties": {
"street": {
"description": "",
"example": "Nove Sady 25",
"type": "string"
},
"city": {
"description": "",
"example": "Brno",
"type": "string"
},
"country": {
"description": "",
"example": "Czech Republic",
"type": "string"
},
"state": {
"description": "",
"example": "Jihomoravsky kraj",
"type": "string"
},
"zip_code": {
"description": "",
"example": "60200",
"type": "string"
},
"phone": {
"description": "",
"example": "+420 444 444 444",
"type": "string"
},
"email": {
"description": "",
"example": "brnocafe@kentico.com",
"type": "string"
}
},
"required": [
"street",
"city",
"country",
"state",
"zip_code",
"phone",
"email"
]
},
"CreatingAContentItemrequest": {
"title": "Creating a content itemRequest",
"example": {
"name": "Brno",
"type": {
"codename": "cafe"
},
"sitemap_locations": [
{
"codename": "cafes"
},
{
"codename": "europe"
}
]
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Brno",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type"
},
"sitemap_locations": {
"description": "",
"example": [
{
"codename": "cafes"
},
{
"codename": "europe"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/SitemapLocation"
}
}
},
"required": [
"name",
"type",
"sitemap_locations"
]
},
"Type": {
"title": "Type",
"example": {
"codename": "cafe"
},
"type": "object",
"properties": {
"codename": {
"description": "",
"example": "cafe",
"type": "string"
}
},
"required": [
"codename"
]
},
"SitemapLocation": {
"title": "SitemapLocation",
"example": {
"codename": "cafes"
},
"type": "object",
"properties": {
"codename": {
"description": "",
"example": "cafes",
"type": "string"
}
},
"required": [
"codename"
]
},
"CreateAContactProfilerequest": {
"title": "Create a contact profileRequest",
"example": {
"uid": "7888c9a3824a11f1",
"sid": "111114cc62300000",
"email": "john.snow@wall.north",
"name": "John Snow",
"company": "Night's Watch",
"phone": "444-256-487",
"website": "http://gameofthrones.wikia.com/wiki/Jon_Snow"
},
"type": "object",
"properties": {
"uid": {
"description": "",
"example": "{{VisitorUid}}",
"type": "string"
},
"sid": {
"description": "",
"example": "{{SessionId}}",
"type": "string"
},
"email": {
"description": "",
"example": "john.snow@wall.north",
"type": "string"
},
"name": {
"description": "",
"example": "John Snow",
"type": "string"
},
"company": {
"description": "",
"example": "Night's Watch",
"type": "string"
},
"phone": {
"description": "",
"example": "444-256-487",
"type": "string"
},
"website": {
"description": "",
"example": "http://gameofthrones.wikia.com/wiki/Jon_Snow",
"type": "string"
}
},
"required": [
"uid",
"sid",
"email",
"name",
"company",
"phone",
"website"
]
},
"RecordACustomActivityrequest": {
"title": "Record a custom activityRequest",
"example": {
"uid": "7888c9a3824a11f1",
"sid": "111114cc62300000",
"codename": "Clicked_facebook_icon"
},
"type": "object",
"properties": {
"uid": {
"description": "",
"example": "{{VisitorUid}}",
"type": "string"
},
"sid": {
"description": "",
"example": "{{SessionId}}",
"type": "string"
},
"codename": {
"description": "",
"example": "Clicked_facebook_icon",
"type": "string"
}
},
"required": [
"uid",
"sid",
"codename"
]
},
"RecordANewSessionrequest": {
"title": "Record a new sessionRequest",
"example": {
"uid": "{{UserId}}",
"sid": "111114cc62300000"
},
"type": "object",
"properties": {
"uid": {
"description": "",
"example": "{{UserId}}",
"type": "string"
},
"sid": {
"description": "",
"example": "{{SessionId}}",
"type": "string"
}
},
"required": [
"uid",
"sid"
]
},
"UpdateAnAssetByIdrequest": {
"title": "Update an asset by IDRequest",
"example": {
"title": "Coffe Brewing Techniques",
"descriptions": [
{
"language": {
"codename": "en-US"
},
"description": "Coffee Brewing Techniques"
},
{
"language": {
"codename": "es-ES"
},
"description": "Técnicas para hacer café"
}
]
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "Coffe Brewing Techniques",
"type": "string"
},
"descriptions": {
"description": "",
"example": [
{
"language": {
"codename": "en-US"
},
"description": "Coffee Brewing Techniques"
},
{
"language": {
"codename": "es-ES"
},
"description": "Técnicas para hacer café"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Description"
}
}
},
"required": [
"title",
"descriptions"
]
},
"Description": {
"title": "Description",
"example": {
"language": {
"codename": "en-US"
},
"description": "Coffee Brewing Techniques"
},
"type": "object",
"properties": {
"language": {
"$ref": "#/definitions/Language"
},
"description": {
"description": "",
"example": "Coffee Brewing Techniques",
"type": "string"
}
},
"required": [
"language",
"description"
]
},
"Language": {
"title": "Language",
"example": {
"codename": "en-US"
},
"type": "object",
"properties": {
"codename": {
"description": "",
"example": "en-US",
"type": "string"
}
},
"required": [
"codename"
]
},
"UpsertAnAssetByExternalIdrequest": {
"title": "Upsert an asset by external IDRequest",
"example": {
"file_reference": {
"id": "fcbb12e6-66a3-4672-85d9-d502d16b8d9c",
"type": "internal"
},
"title": "Coffe Brewing Techniques",
"descriptions": [
{
"language": {
"codename": "en-US"
},
"description": "Coffee Brewing Techniques"
},
{
"language": {
"codename": "es-ES"
},
"description": "Técnicas para hacer café"
}
]
},
"type": "object",
"properties": {
"file_reference": {
"$ref": "#/definitions/FileReference"
},
"title": {
"description": "",
"example": "Coffe Brewing Techniques",
"type": "string"
},
"descriptions": {
"description": "",
"example": [
{
"language": {
"codename": "en-US"
},
"description": "Coffee Brewing Techniques"
},
{
"language": {
"codename": "es-ES"
},
"description": "Técnicas para hacer café"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Description"
}
}
},
"required": [
"file_reference",
"title",
"descriptions"
]
},
"FileReference": {
"title": "FileReference",
"example": {
"id": "fcbb12e6-66a3-4672-85d9-d502d16b8d9c",
"type": "internal"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": "fcbb12e6-66a3-4672-85d9-d502d16b8d9c",
"type": "string"
},
"type": {
"description": "",
"example": "internal",
"type": "string"
}
},
"required": [
"id",
"type"
]
},
"UpsertAVariantByLanguageIdrequest": {
"title": "Upsert a variant by language IDRequest",
"example": {
"elements": {
"personas": [
{
"codename": "barista"
},
{
"codename": "coffee_blogger"
}
],
"title": "En Asados",
"post_date": "2014-11-07T00:00:00Z",
"summary": "Tostar granos de café puede tardar de 6 a 13 minutos. ...",
"related_articles": [
{
"codename": "coffee_processing_techniques"
},
{
"codename": "origins_of_arabica_bourbon"
}
],
"meta_keywords": "asados, café",
"meta_description": "Tostar granos de café puede tardar de 6 a 13 minutos. ...",
"url_pattern": "on-roasts"
}
},
"type": "object",
"properties": {
"elements": {
"$ref": "#/definitions/Elements16"
}
},
"required": [
"elements"
]
},
"Elements16": {
"title": "Elements16",
"example": {
"personas": [
{
"codename": "barista"
},
{
"codename": "coffee_blogger"
}
],
"title": "En Asados",
"post_date": "2014-11-07T00:00:00Z",
"summary": "Tostar granos de café puede tardar de 6 a 13 minutos. ...",
"related_articles": [
{
"codename": "coffee_processing_techniques"
},
{
"codename": "origins_of_arabica_bourbon"
}
],
"meta_keywords": "asados, café",
"meta_description": "Tostar granos de café puede tardar de 6 a 13 minutos. ...",
"url_pattern": "on-roasts"
},
"type": "object",
"properties": {
"personas": {
"description": "",
"example": [
{
"codename": "barista"
},
{
"codename": "coffee_blogger"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Persona"
}
},
"title": {
"description": "",
"example": "En Asados",
"type": "string"
},
"post_date": {
"description": "",
"example": "11/7/2014 12:00:00 AM",
"type": "string"
},
"summary": {
"description": "",
"example": "Tostar granos de café puede tardar de 6 a 13 minutos. ...",
"type": "string"
},
"related_articles": {
"description": "",
"example": [
{
"codename": "coffee_processing_techniques"
},
{
"codename": "origins_of_arabica_bourbon"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/RelatedArticle"
}
},
"meta_keywords": {
"description": "",
"example": "asados, café",
"type": "string"
},
"meta_description": {
"description": "",
"example": "Tostar granos de café puede tardar de 6 a 13 minutos. ...",
"type": "string"
},
"url_pattern": {
"description": "",
"example": "on-roasts",
"type": "string"
}
},
"required": [
"personas",
"title",
"post_date",
"summary",
"related_articles",
"meta_keywords",
"meta_description",
"url_pattern"
]
},
"Persona": {
"title": "Persona",
"example": {
"codename": "barista"
},
"type": "object",
"properties": {
"codename": {
"description": "",
"example": "barista",
"type": "string"
}
},
"required": [
"codename"
]
},
"RelatedArticle": {
"title": "RelatedArticle",
"example": {
"codename": "coffee_processing_techniques"
},
"type": "object",
"properties": {
"codename": {
"description": "",
"example": "coffee_processing_techniques",
"type": "string"
}
},
"required": [
"codename"
]
},
"UpsertAVariantByLanguageCodenamerequest": {
"title": "Upsert a variant by language codenameRequest",
"example": {
"elements": {
"personas": [
{
"codename": "barista"
},
{
"codename": "coffee_blogger"
}
],
"title": "En Asados",
"post_date": "2014-11-07T00:00:00Z",
"summary": "Tostar granos de café puede tardar de 6 a 13 minutos. ...",
"related_articles": [
{
"codename": "coffee_processing_techniques"
},
{
"codename": "origins_of_arabica_bourbon"
}
],
"meta_keywords": "asados, café",
"meta_description": "Tostar granos de café puede tardar de 6 a 13 minutos. ...",
"url_pattern": "on-roasts"
}
},
"type": "object",
"properties": {
"elements": {
"$ref": "#/definitions/Elements16"
}
},
"required": [
"elements"
]
},
"AddAnAssetrequest": {
"title": "Add an assetRequest",
"example": {
"file_reference": {
"id": "fcbb12e6-66a3-4672-85d9-d502d16b8d9c",
"type": "internal"
},
"title": "Coffee Brewing Techniques",
"external_id": "which-brewing-fits-you",
"descriptions": [
{
"language": {
"codename": "en-US"
},
"description": "Coffee Brewing Techniques"
},
{
"language": {
"codename": "es-ES"
},
"description": "Técnicas para hacer café"
}
]
},
"type": "object",
"properties": {
"file_reference": {
"$ref": "#/definitions/FileReference"
},
"title": {
"description": "",
"example": "Coffee Brewing Techniques",
"type": "string"
},
"external_id": {
"description": "",
"example": "which-brewing-fits-you",
"type": "string"
},
"descriptions": {
"description": "",
"example": [
{
"language": {
"codename": "en-US"
},
"description": "Coffee Brewing Techniques"
},
{
"language": {
"codename": "es-ES"
},
"description": "Técnicas para hacer café"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Description"
}
}
},
"required": [
"file_reference",
"title",
"external_id",
"descriptions"
]
}
}
}