{
"opencollection": "1.0.0",
"info": {
"name": "Acoustic Content API",
"version": "1.0.142"
},
"items": [
{
"info": {
"name": "Authoring assets",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all assets.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/assets",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of assets to return in a single result. Set to 50 by default."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of assets to skip from the beginning of the list and return the rest."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional: Parameters used to include additional fields inside each returned asset. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the asset. Use \"metadata\" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, \"include=links,metadata\"."
}
]
},
"docs": "Use this endpoint to retrieve all assets from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create an asset.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/assets",
"headers": [
{
"name": "x-ibm-dx-publish-priority",
"value": ""
}
],
"params": [
{
"name": "md5",
"value": "",
"type": "query",
"description": "Provide the Base64 encoded MD5 checksum of the resource. This is only used when creating the asset and resource simultaneously."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional: Parameters used to include additional fields inside each returned asset. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the asset. Use \"metadata\" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, \"include=links,metadata\"."
},
{
"name": "analyze",
"value": "",
"type": "query",
"description": "Set the analyze parameter to true to enable the AI tag analysis. Analysis will only occur for managed assets."
},
{
"name": "autocurate",
"value": "",
"type": "query",
"description": "Set the autocurate parameter to true automatically curate and accept all suggested tags."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to create an asset. There are two ways to use this endpoint. The first method is to create a resource separately, then provide the resource id in the json body of the request along with any other desired data. The second method is to provide resource binary as a multipart field. Another multipart field containing any additional data can then be optionally provided. The second method allows the asset and resource to be created simultaneously. Note:- If AI tag analysis is enabled"
},
{
"info": {
"name": "Retrieve an existing asset.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/assets/:id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the asset that you want to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional: Parameters used to include additional fields inside each returned asset. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the asset. Use \"metadata\" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, \"include=links,metadata\"."
}
]
},
"docs": "Use this endpoint to retrieve an existing asset that matches the ID that is specified from the database. A conditional request is supported.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing asset.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/assets/:id",
"headers": [
{
"name": "If-Match",
"value": ""
},
{
"name": "x-ibm-dx-publish-priority",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the asset that you want to update."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional: Parameters used to include additional fields inside each returned asset. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the asset. Use \"metadata\" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, \"include=links,metadata\"."
},
{
"name": "forceOverride",
"value": "",
"type": "query",
"description": "Specifies whether revision checking should be disabled."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this end-point to update an existing asset that matches the ID that is specified. A conditional request is supported. Note:- If AI tag analysis is enabled, it starts in the background. AI analyzes and provides tag recommendations for the asset that is created.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Delete an existing asset.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/assets/:id",
"headers": [
{
"name": "If-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the asset that you want to delete."
}
]
},
"docs": "Use this endpoint to immediately delete an existing asset from the database.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve an existing asset by path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/assets/record",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "path",
"value": "",
"type": "query",
"description": "Provide the path of the asset that you want to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional: Parameters used to include additional fields inside each returned asset. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the asset. Use \"metadata\" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, \"include=links,metadata\"."
}
]
},
"docs": "Use this endpoint to retrieve an existing asset that matches the path that has been set. A conditional request is supported.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "AI analyzes the asset. The analysis results are stored on the asset itself.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/assets/:id/analyze",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the asset item that you need to perform AI analytics."
},
{
"name": "autocurate",
"value": "",
"type": "query",
"description": "Set the autocurate parameter to true automatically curate and accept all suggested tags."
}
]
},
"docs": "Use the /assets/{id}/analyze endpoint to perform AI analysis on asset if supported.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Create a draft of existing asset.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/assets/:id/create-draft",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the asset item that you need to create draft of."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional: Parameters used to include additional fields inside each returned asset. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the asset. Use \"metadata\" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, \"include=links,metadata\"."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default."
}
]
},
"docs": "Use this endpoint to create draft of existing asset and return the draft if successful.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve all assets modified within the specified date",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/assets/views/by-modified",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the asset that you want returned. The assets that were modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the asset that you want returned. The assets that were modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of assets to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of assets to return in a single result."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the assets to be returned in ascending or descending order. Assets are returned in descending order by default."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional: Parameters used to include additional fields inside each returned asset. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the asset. Use \"metadata\" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, \"include=links,metadata\"."
}
]
},
"docs": "Use the /assets/views/by-modified endpoint to retrieve all assets that was modified within the date range specified.
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring categories",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all the taxonomies.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/categories",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of content items to return in a single result. The default value is 50."
}
]
},
"docs": "Retrieve all the taxonomies (root categories).
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create a new category.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/categories",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a category with the contents of the JSON body.
User roles: admin, manager"
},
{
"info": {
"name": "Retrieve an existing category item.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/categories/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the category to retrieve."
}
]
},
"docs": "Retrieve the category with ID {id}.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing category item.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/categories/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the category to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the category with ID {id}.
User roles: admin, manager"
},
{
"info": {
"name": "Delete an existing category item.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/categories/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the category to delete."
}
]
},
"docs": "Delete the category with ID {id} along with all the categories under it.
User roles: admin, manager"
},
{
"info": {
"name": "Gets all categories modified between the start and end date.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/categories/views/by-modified",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the category items that you want returned. The category items that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the category items that you want returned. The category items that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the category items fields that are specified here are returned for each result. Any category item field is a valid value and can be specified as a comma-separated list. For example, to list the category item fields name and ID, provide the value ID, and name. All category item fields are returned by default."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of category items to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of category items to return in a single result. The default value is 50."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the category items to be returned in ascending or descending order. Documents are returned in descending order by default."
}
]
},
"docs": "This endpoint returns a paged result view of category items modified within a range specified by start and end date.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve the child categories of the category with ID {id}.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/categories/:id/children",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the category whose children to retrieve."
},
{
"name": "recurse",
"value": "",
"type": "query",
"description": "Set to true to recursively retrieve all the sub-categories of the children as well."
}
]
},
"docs": "Retrieve the child categories of the category with ID {id}.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all the taxonomies and their children.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v2/categories",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of content items to return in a single result. The default value is 50."
},
{
"name": "depth",
"value": "",
"type": "query",
"description": "Used to specify the depth of the children to return. 1 -7 returns the given depth. Values above 7 or no value result in all categories."
}
]
},
"docs": "Retrieve all the taxonomies and thier children. Optional depth query string limits the depth of the categories returned.
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring changes",
"type": "folder"
},
"items": [
{
"info": {
"name": "Mark items as ready for publishing in bulk.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/changes/status/ready",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the `/changes/status/ready` endpoint to change the status of multiple items to the `ready` state.\nCurrently only Assets and Content support for workflow states.\n\n\n### Example Requests: ###\n#### Change the status of a content and an asset to the ready state ####\nSpecify the items that you want to change to the ready state in the request body.\n##### Request: #####\n~~~\n {\n \"ids\": [\n {\n \"id\": \"579c2232-7398-4c8b-921d-3932bfc45d19\",\n \"classification\": \"content\"\n "
},
{
"info": {
"name": "Bulk retire items.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/changes/status/retire",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the `/changes/status/retire` endpoint to change the status of multiple items to the retired state. Currently, only Assets and Content support workflow states. For examples of request, see the documentation for `changes/status/ready` endpoint.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Beta - Bulk delete items.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/changes/delete",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This is a Beta API it is subject to change. Use the `/changes/delete` endpoint to delete multiple items. Currently, only assets and content are supported.\n\n## Requests\nSpecify the items that you want to delete in the request body.\n#\n~~~\n {\n \"ids\": [\n {\n \"id\": \"579c2232-7398-4c8b-921d-3932bfc45d19\",\n \"classification\": \"content\"\n },\n {\n \"id\": \"448e8d63-ed15-4d59-85e5-53908a84ca93\",\n \"classification\": \"asset\"\n }\n ]\n }\n~~~\n#\nAlternatively you c"
},
{
"info": {
"name": "Beta - Bulk move items to another library.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/changes/set-library",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This is a Beta API it is subject to change. Use the `/changes/set-library` endpoint to move multiple items to library. Currently, only assets and content are supported. Admin can move items between libraries without restrictions. Manager and Editor must be a contributor in both the source and destination libraries.\n\n## Requests\nSpecify the items that you want to move in the request body. Specify destination library id as well\n#\n~~~\n {\n \"ids\": [\n {\n \"id\": \"579c2232-7398-4c8b-921d-"
},
{
"info": {
"name": "Mark the item with the specified unique ID as ready for publishing.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/changes/:uid/status/ready",
"params": [
{
"name": "uid",
"value": "",
"type": "path",
"description": "Provide the unique ID of the item that you want to mark as ready for publishing."
},
{
"name": "rev",
"value": "",
"type": "query",
"description": "Optional. Define the revision of item."
}
]
},
"docs": "Use the `/changes/{uid}/status/ready` endpoint to ready a single item with the specified unique ID. The unique ID (uid) is the items classification and the ID combined to create an ID that is unique across all items in Content.\nIf the item is used by other draft items then you must use the Bulk ready API to mark a group of inter-dependent items as ready for publishing.\nCurrently, only Assets and Content support workflow.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retire an item with the specified unique ID.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/changes/:uid/status/retire",
"params": [
{
"name": "uid",
"value": "",
"type": "path",
"description": "Provide the unique ID of the item that you want to retire."
},
{
"name": "rev",
"value": "",
"type": "query",
"description": "Optional.Define the revision of item."
}
]
},
"docs": "Use the `/changes/{uid}/status/retire` endpoint to retire a single item with the specified unique ID. The unique ID (uid) is the items classification and the ID combined to create an ID that is unique across all content hub items.\nIf the item has draft dependencies then you must use the Bulk retire API to retire the group of dependent items.\nCurrently, only Assets and Content support workflow.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Mark an item with the specified classification and ID as ready for publishing.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/changes/:classification/:id/status/ready",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the item that you want to mark as ready for publishing."
},
{
"name": "classification",
"value": "",
"type": "path",
"description": "Provide the classification of the item that you want to mark as ready for publishing."
},
{
"name": "rev",
"value": "",
"type": "query",
"description": "Optional. Define the revision of the item."
}
]
},
"docs": "Use the `/changes/{classification}/{id}/status/ready` endpoint to ready a single item with the specified classification and ID.\nIf the item is used by other draft items then you must use the Bulk ready API to mark a group of inter-dependent items as ready for publishing.\nCurrently, only Assets and Content support workflow.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retire an item with the specified classification and ID.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/changes/:classification/:id/status/retire",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the item that you want to retire."
},
{
"name": "classification",
"value": "",
"type": "path",
"description": "Provide the classificaiton of the item that you want to retire."
},
{
"name": "rev",
"value": "",
"type": "query",
"description": "Optional. Define the revision of item."
}
]
},
"docs": "Use the `/changes/{classification}/{id}/status/retire` endpoint to retire a single item with the specified classification and ID.\nIf the item has draft dependencies then you must use the Bulk retire API to retire the group of dependent items.\nCurrently, only Assets and Content support workflow.\n
User roles: admin, manager, editor"
}
]
},
{
"info": {
"name": "Authoring comments",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a comment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/comments",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /comments endpoint to create a comment. You must provide a message and a target to create the comment.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve an existing comment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/comments/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the comment that you want to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the comment properties that are specified here are returned for each result. Any comment property is a valid value and can be specified in a comma-separated list. For example, to show only the comment properties message and creatorId, provide the values of message and creatorId. All comment properties are returned by default."
}
]
},
"docs": "Use the /comments/{id} endpoint to retrieve an existing comment that matches the ID that is specified from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing comment.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/comments/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the comment that you want to update."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the comment properties that are specified here are returned for each result. Any comment property is a valid value and can be specified in a comma-separated list. For example, to show only the comment properties message and creatorId, provide the values of message and creatorId. All comment properties are returned by default."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /comments/{id} end point to update an existing comment that matches the ID that is specified.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Delete an existing comment.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/comments/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the comment that you want to delete."
}
]
},
"docs": "Use the /comments/{id} endpoint to delete an existing comment from the database.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve all comments for a specific item.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/comments/by-item/:classification/:id",
"params": [
{
"name": "classification",
"value": "",
"type": "path",
"description": "Provide the classification of the item for which you want to retrieve the comments."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide ID of the item for which you want to retrieve the comments."
},
{
"name": "since",
"value": "",
"type": "query",
"description": "Provide the date from when to retrieve comments. Only comments that were added after this date are retrieved. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of comments to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of comments to return in a single result. The maximum number of comments that are returned by default is 50."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the comments to be returned in ascending or descending order. Comments are returned in descending order by default."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the comment properties that are specified here are returned for each result. Any comment property is a valid value and can be specified in a comma-separated list. For example, to show only the comment properties message and creatorId, provide the values of message and creatorId. All comment properties are returned by default."
}
]
},
"docs": "Use the /comments/by-item/{classification}/{id} endpoint to fetch all comments that are associated to a specific item. Use the query parameter 'since' to fetch comments since a specific date. Conditional requests are supported.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all comments that were created by a user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/comments/by-user/:userId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "Provide the ID of the user that created the comment."
},
{
"name": "since",
"value": "",
"type": "query",
"description": "Retrieve only comments newer than this date. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of comments to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of comments to return in a single result. The maximum number of comments that are returned by default is 50."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the comments to be returned in ascending or descending order. Comments are returned in descending order by default."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the comment properties that are specified here are returned for each result. Any comment property is a valid value and can be specified in a comma-separated list. For example, to show only the comment properties message and creatorId, provide the values of message and creatorId. All comment properties are returned by default."
}
]
},
"docs": "Use the /comments/by-user/{userId} endpoint to fetch all comments that were created by the specified user. Optionally, the query parameter since can be used to fetch comments only 'since' a specific date.
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring content",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all content items in the database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/content",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of content items to return in a single result. The default value is 50."
}
]
},
"docs": "Use the /content endpoint to list all content items in the database.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create content items.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/content",
"headers": [
{
"name": "x-ibm-dx-publish-priority",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /content endpoint to create content. A content type must be specified through the typeId property. You cannot create content without a content type.\n\n### Example: ###\nCreates a readied content that contains the name and birthday of a person.\n#\n~~~\n{\n \"name\": \"Person\",\n \"typeId\": \"b0798e67-3da2-48b4-b044-016495fa3ead\",\n \"status\": \"ready\",\n \"elements\": {\n \"name\": {\n \"elementType\": \"text\",\n \"value\": \"Thomas Watson\"\n },\n \"birthday\": {\n \"elementType\": \"datetime\",\n "
},
{
"info": {
"name": "Retrieve an existing content item.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/content/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content item that you want to retrieve."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional. Parameters used to include additional fields inside each returned content item. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the content item. Use \"metadata\" to include additional fields for each of the items referenced by the content item, such as the URL of the referenced assets. You can specify multiple fields as a comma-separated value. For example, \"include=links, metadata\"."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default."
}
]
},
"docs": "Use the /content/{id} endpoint to retrieve an existing content item from the database. This endpoint returns the API representation of a content item.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing content item.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/content/:id",
"headers": [
{
"name": "x-ibm-dx-publish-priority",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content item that you want to update."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional. Parameters used to include additional fields inside each returned content item. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the content item. Use \"metadata\" to include additional fields for each of the items referenced by the content item, such as the URL of the referenced assets. You can specify multiple fields as a comma-separated value. For example, \"include=links, metadata\"."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default."
},
{
"name": "forceOverride",
"value": "",
"type": "query",
"description": "Force this update over the existing content item. When set to true, this request will overwrite the stored content, regardless of a difference in revisions (ignoring or reverting changes that were made since the item was last retrieved)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /content/{id} end point to update an existing content item. You must retrieve the content item first by using the GET endpoint before you can update. This endpoint requires the full representation of the content item to update it. If there is a need to preview and/or review changes to the item prior to the update going live, first use the /content/{id}/create-draft endpoint to create a draft of the item and perform the update on the draft version. Following this, the draft may then be re"
},
{
"info": {
"name": "Delete an existing content item immediately.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/content/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content item that you want to delete."
}
]
},
"docs": "Use the /content/{id} endpoint to delete an existing content item in the database. If the content item that you want to delete has an active draft version, then you cannot delete it. Delete the draft version of the content item and then delete the content item.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve all content of the specified type.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/content/views/by-type",
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "Provide the ID of the content type by which you want to filter the content items."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of content items to return in a single result. The default value is 50."
}
]
},
"docs": "Use the /content/views/by-type endpoint to retrieve all content items of a specified content type from the database.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all content modified within the specified date.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/content/views/by-modified",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the content items that you want returned. The content items that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ. Note: when reversing the order you do not switch start and end."
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the content items that you want returned. The content items that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ. Note: when reversing the order you do not switch start and end."
},
{
"name": "startId",
"value": "",
"type": "query",
"description": "If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId. Note: when reversing the order you do not switch start and end ids."
},
{
"name": "endId",
"value": "",
"type": "query",
"description": "If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId. Note: when reversing the order you do not switch start and end ids."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of content items to return in a single result. The default value is 50. You can pass 0 to unset the limit and stream all available results. A streaming parser can be avoided with format=sequence."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest. Note: large offsets perform poorly. Use start keys to index into large result sets. Also see pageMode."
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify the order of the results.\n * `ascending` - (default) result keys are increasing\n * `descending` - result keys are decreasing\n\nIt is not necessary to switch the start and end keys and ids when reversing the order.\n"
}
]
},
"docs": "Use the /content/views/by-modified endpoint to retrieve all content items that was modified within the date range specified.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create a draft version of an existing content item.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/content/:id/create-draft",
"headers": [
{
"name": "If-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content item that you want to create a draft version."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional. Parameters used to include additional fields inside each returned content item. Use \"links\" to include the links section, which contains URLs for actions that can be performed on the content item. Use \"metadata\" to include additional fields for each of the items referenced by the content item, such as the URL of the referenced assets. You can specify multiple fields as a comma-separated value. For example, \"include=links, metadata\"."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default."
}
]
},
"docs": "Use the /content/{id}/create-draft endpoint to create a draft version of an existing content item. You can create a draft version when a content item document is in ready or retired status. If a draft of the content item already exists, you cannot create a draft.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve the total number of content items in the database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/content/count"
},
"docs": "
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "AI analyzes and provides tag recommendations for the content.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/content/:id/analyze",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content item that you need to perform AI analytics."
}
]
},
"docs": "Use the /content/{id}/analyze endpoint to perform AI analysis on content text.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Validate the specified content item against its type.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/content/:id/validate",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content document that you want to validate."
}
]
},
"docs": "Use the /content/{id}/validate end-point to validate if the content item specified matches its recorded content type.
User roles: admin, manager, editor"
}
]
},
{
"info": {
"name": "Authoring Import",
"type": "folder"
},
"items": [
{
"info": {
"name": "Copies the specified documents.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/copy/sync",
"headers": [
{
"name": "x-ibm-dx-publish-priority",
"value": ""
}
],
"params": [
{
"name": "referencesToClear",
"value": "",
"type": "query",
"description": "Optional comma separated list of reference types to clear within copied documents.\nSupported values: `asset`, `content`, `category`, `image-profile`\n"
},
{
"name": "referencesToClone",
"value": "",
"type": "query",
"description": "Optional comma separated list of reference types to copy (when referenceLevels > 0).\nDefaults to the reference types of the initial items to copy.\nSupported values: asset, content\n"
},
{
"name": "referenceLevels",
"value": "",
"type": "query",
"description": "The number of reference levels to copy. Defaults to 0, meaning to copy only the specified items."
},
{
"name": "clearElementsOnLastLevel",
"value": "",
"type": "query",
"description": "Specifies whether the elements on the last level of references should have their elements cleared.\nHas no effect when referencesLevels is not greater than zero.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the `/authoring/v1/copy/sync` endpoint to copy the specified documents for the current tenant.\nCurrently supported document classifications are `asset` and `content`.\nAs for all Acoustic Content PUT and POST requests, the Content-Type header should be set to application/json.\n
User roles: admin, manager"
}
]
},
{
"info": {
"name": "Authoring layouts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all layouts in the database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layouts",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of layouts to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of layouts that are returned."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the layouts to be returned in ascending/alphabetical (default) or descending/reverse-alphabetical order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list."
}
]
},
"docs": "Use the /layouts endpoint to retrieve all layouts from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create new layouts.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/layouts",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /layouts end-point to create a new layout.
User roles: admin, manager"
},
{
"info": {
"name": "Retrieves the layouts associated with the specified content.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layouts/by-content/:content-id",
"headers": [
{
"name": "x-ibm-dx-project-id",
"value": ""
}
],
"params": [
{
"name": "content-id",
"value": "",
"type": "path",
"description": "The ID of the content whose associated layouts should be returned."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Optionally specifies the context for draft overlay. Contains the project id, or special values:\n * draft for standalone draft overlays\n * none for no project overlay.\n\nWhen both the 'projectId' query-string parameter AND the 'x-ibm-dx-project-id' header are specified, the 'projectId' query-string parameter will override the 'x-ibm-dx-project-id' header.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "An optional filter to control the returned results.\nValid options are:\n * selected: Indicates that only the selected layout should be returned.\n"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of layouts to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of layouts that are returned."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list."
}
]
},
"docs": "Use the /layouts/by-content/{contentId} endpoint to retrieve the layouts associated with the specified content. When the 'filter' query string parameter is set to 'selected', only the selected layout (which could be a content override) is returned.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve an existing layout by its path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layouts/by-path",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "path",
"value": "",
"type": "query",
"description": "The path of the layout to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list that when specified, limits the fields returned to just those specified. Any layout field is a valid value."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n * metadata: Adds additional details such as creator and last modifier to the response.\n * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
}
]
},
"docs": "Use the /layouts/by-path end-point to retrieve an existing layout from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve the total number of layouts.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layouts/count"
},
"docs": "Use the /layouts/count endpoint to obtain the total number of layouts within the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve an existing layout.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layouts/:id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the layout to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list that when specified, limits the fields returned to just those specified. Any layout field is a valid value."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n * metadata: Adds additional details such as creator and last modifier to the response.\n * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
}
]
},
"docs": "Use the /layouts/{id} end-point to retrieve an existing layout from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing layout.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/layouts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the layout document to update."
},
{
"name": "forceOverride",
"value": "",
"type": "query",
"description": "Specifies whether revision checking should be disabled."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /layouts/{id} end-point to update an existing layout within the database.
User roles: admin, manager"
},
{
"info": {
"name": "Delete an existing layout.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/layouts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the layout to delete."
}
]
},
"docs": "Use the /layouts/{id} endpoint to delete an existing layout from the database.
User roles: admin, manager"
},
{
"info": {
"name": "Retrieve all layouts in the database ordered by last modified date.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layouts/views/by-modified",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the layouts that you want returned.\nWhen the order is ascending (default), the layouts that are modified on or after this date and time are returned.\nWhen the order is descending, the layouts that are modified on or before this date and time are returned.\nThe date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.\n"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the layouts that you want returned.\nWhen the order is ascending (default), the layouts that are modified on or before this date and time are returned.\nWhen the order is descending, the layouts that are modified on or after this date and time are returned.\nThe date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.\n"
},
{
"name": "startId",
"value": "",
"type": "query",
"description": "If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId.\n"
},
{
"name": "endId",
"value": "",
"type": "query",
"description": "If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId.\n"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of layouts to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of layouts that are returned."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the layout documents to be returned in ascending/oldest-first (default) or descending/newest-first order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list."
}
]
},
"docs": "Use the /layouts/views/by-modified endpoint to retrieve all layouts from the database and list them in the order of their last modified date.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all layouts in the database with the specified name.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layouts/views/by-name",
"params": [
{
"name": "name",
"value": "",
"type": "query",
"description": "The name to query."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of layouts to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of layouts that are returned."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
}
]
},
"docs": "Use the /layouts/views/by-name endpoint to retrieve all layouts from the database with the specified name.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all layout mappings in the database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layout-mappings",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of layout mappings to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of layout mappings that are returned."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the layout mappings to be returned in ascending (default) or descending order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the layout mapping fields that are specified here are returned for each result. Any layout mapping field is a valid value and can be specified as a comma-separated list."
}
]
},
"docs": "Use the /layout-mappings endpoint to retrieve all layout mappings from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create new layout mappings.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/layout-mappings",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /layout-mapping end-point to create a new layout mapping.
User roles: admin, manager"
},
{
"info": {
"name": "Retrieve an existing layout mapping by its path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/by-path",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "path",
"value": "",
"type": "query",
"description": "The path of the layout mapping to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list that when specified, limits the fields returned to just those specified. Any layout mapping field is a valid value."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n * metadata: Adds additional details such as creator, last modifier and the names of mapped layouts to the response.\n * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
}
]
},
"docs": "Use the /layout-mappings/by-path end-point to retrieve an existing layout mapping from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve an existing layout mapping via its associated content-type.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/by-type/:type-id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "type-id",
"value": "",
"type": "path",
"description": "The ID of the content-type whose layout mapping should be retrieved."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list that when specified, limits the fields returned to just those specified. Any layout mapping field is a valid value."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n * metadata: Adds additional details such as creator, last modifier and the names of mapped layouts to the response.\n * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
}
]
},
"docs": "Use the /layout-mappings/by-type/{type-id} end-point to retrieve an existing layout mapping from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Deletes an existing layout mapping via its associated content-type.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/by-type/:type-id",
"params": [
{
"name": "type-id",
"value": "",
"type": "path",
"description": "The ID of the content-type whose layout mapping should be deleted."
}
]
},
"docs": "Use the /layout-mappings/by-type/{type-id} end-point to delete an existing layout mapping from the database.
User roles: admin, manager"
},
{
"info": {
"name": "Copies an existing layout mapping via its associated content-type.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/by-type/:type-id/copy",
"params": [
{
"name": "type-id",
"value": "",
"type": "path",
"description": "The ID of the content-type whose layout mapping should be copied."
},
{
"name": "targetTypeId",
"value": "",
"type": "query",
"description": "The ID of the content-type to associate with the copy."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "An optional name to associate with the copy. If there is an existing layout mapping with the specified name, then the copied document will have a name in the format 'Copy [NUMBER] of [NAME]'"
}
]
},
"docs": "Use the /layout-mappings/by-type/{type-id}/copy end-point to create a duplicate of a layout mapping. The new layout mapping will have a name in the format 'Copy [NUMBER] of [SOURCE-NAME]'
User roles: admin, manager"
},
{
"info": {
"name": "Retrieve the total number of layout mappings.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/count"
},
"docs": "Use the /layout-mappings/count endpoint to obtain the total number of layout mappings within the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve an existing layout mapping.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/:id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the layout mapping to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list that when specified, limits the fields returned to just those specified. Any layout mapping field is a valid value."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n * metadata: Adds additional details such as creator, last modifier and the names of mapped layouts to the response.\n * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
}
]
},
"docs": "Use the /layout-mappings/{id} end-point to retrieve an existing layout mapping from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing layout mapping.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the layout mapping document to update."
},
{
"name": "forceOverride",
"value": "",
"type": "query",
"description": "Specifies whether revision checking should be disabled."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /layout-mappings/{id} end-point to update an existing layout mapping within the database.
User roles: admin, manager"
},
{
"info": {
"name": "Delete an existing layout mapping.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the layout mapping to delete."
}
]
},
"docs": "Use the /layout-mappings/{id} endpoint to delete an existing layout mapping from the database.
User roles: admin, manager"
},
{
"info": {
"name": "Copies an existing layout mapping.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/:id/copy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the layout mapping that you wish to copy."
},
{
"name": "typeId",
"value": "",
"type": "query",
"description": "The ID of the content-type to associate with the copy."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "An optional name to associate with the copy. If there is an existing layout mapping with the specified name, then the copied document will have a name in the format 'Copy [NUMBER] of [NAME]'"
}
]
},
"docs": "Use the /layout-mappings/{id}/copy end-point to create a duplicate of a layout mapping. The new layout mapping will have a name in the format 'Copy [NUMBER] of [SOURCE-NAME]'
User roles: admin, manager"
},
{
"info": {
"name": "Retrieve all layout mappings in the database ordered by last modified date.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/views/by-modified",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the layout mappings that you want returned.\nWhen the order is ascending (default), the layouts that are modified on or after this date and time are returned.\nWhen the order is descending, the layouts that are modified on or before this date and time are returned.\nThe date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.\n"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the layout mappings that you want returned.\nWhen the order is ascending (default), the layouts that are modified on or before this date and time are returned.\nWhen the order is descending, the layouts that are modified on or after this date and time are returned.\nThe date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.\n"
},
{
"name": "startId",
"value": "",
"type": "query",
"description": "If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId.\n"
},
{
"name": "endId",
"value": "",
"type": "query",
"description": "If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId.\n"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of layout mappings to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of layout mappings that are returned."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the layout mapping documents to be returned in ascending/oldest-first (default) or descending/newest-first order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the layout mapping fields that are specified here are returned for each result. Any layout mapping field is a valid value and can be specified as a comma-separated list."
}
]
},
"docs": "Use the /layout-mappings/views/by-modified endpoint to retrieve all layout mappings from the database and list them in the order of their last modified date.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all layout mappings in the database with the specified name.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/layout-mappings/views/by-name",
"params": [
{
"name": "name",
"value": "",
"type": "query",
"description": "The name to query."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of layout mappings to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of layout mappings that are returned."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the layout mapping fields that are specified here are returned for each result. Any layout mapping field is a valid value and can be specified as a comma-separated list."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
}
]
},
"docs": "Use the /layout-mappings/views/by-name endpoint to retrieve all layout mappings from the database with the specified name.
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring reference",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve the outgoing references for items.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/references/outgoing",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the `/references/outgoing` endpoint to retrieve outgoing references for items. This endpoint allows batch lookups by allowing multiple items to be looked at the same time\n### Examples: ###\n#### A simple lookup of the outgoing references for one item ####\nThe default depth to look for references in an item is `1`. If it is `depth.reached` and there are more references that are found in the item, the result `code` that is returned indicates that there are more references.\nYou can then either q"
},
{
"info": {
"name": "Retrieve the outgoing references for an item with the provided ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/references/outgoing/:classification/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the item for which you want to fetch references."
},
{
"name": "classification",
"value": "",
"type": "path",
"description": "Provide the classification of the item for which you want to fetch references."
},
{
"name": "filterType",
"value": "",
"type": "query",
"description": "Use the `filterType` parameter to inverse the filters. For example, if you are using `classifications=content-type`, it returns only content-types, however if you add `filterType=exclude` then, it returns everything besides content-types."
},
{
"name": "depth",
"value": "",
"type": "query",
"description": "The amount of depth to recursively look for references in an item. The default depth to look for references in an item is 1, so only direct outgoing references are returned. Use a higher amount of depth to get recursive references. Currently, you can request a maximum depth of 10 in one query. The filters like `classifications` and `statuses` can be used to limit amount of data that is returned when you work with references."
},
{
"name": "classifications",
"value": "",
"type": "query",
"description": "Classification of items to filter references by."
},
{
"name": "statuses",
"value": "",
"type": "query",
"description": "Provide the workflow status of the item to filter references. If items do not have workflow status, they are normally considered to be in the `ready` state for the purpose of this filtering."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Use the 'include' parameter to add options to references that you fetch for an item. Currently, the only available option is `metadata`. When you use the `metadata` option in the `include` parameter, the returned code includes metadata about each of the references that are returned. The information that is returned can be controlled by using the `fl` parameter."
},
{
"name": "fl",
"value": "",
"type": "query",
"description": "The fields that you can specify in the `fl` parameter are similar to the `fl` query parameters in `/authoring/v1/search` API. You can use the `fl` parameter only if you are also using the `include=metadata` parameter. For example, to retrieve all the document for each of the references use `fl=document`. If the field is not specified, the default fields are returned. The `id` field is always returned by default."
}
]
},
"docs": "Use the /references/outgoing/{classification}/{id} endpoint to retrieve outgoing references for an item with the provided ID. The usage is similar to the batch outgoing reference endpoint (/reference/outgoing/) except the parameters are passed through query parameters and only one item can be requested at a time.\n\n ### Examples: ###\n #### A simple lookup of the outgoing references for one item ####\n The default depth to look for references in an item is `1`. If it is `depth.reached` and there ar"
},
{
"info": {
"name": "Retrieve the incoming references for items.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/references/incoming",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the `/references/incoming` endpoint to retrieve incoming references for items. This endpoint allows batch lookups by allowing multiple items to be looked at the same time\n### Examples: ###\n#### A simple lookup of the incoming references for one item ####\n\nThe results are returned in a key value format with the `references` field where the key is the content hub ID of the item.\n\nIn Graph terminology, each element in the references object is a Node and the array of IDs in the `included` array "
},
{
"info": {
"name": "Retrieve the incoming references for an item with the provided ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/references/incoming/:classification/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the item for which you want to fetch incoming references."
},
{
"name": "classification",
"value": "",
"type": "path",
"description": "Provide the classification of the item for which you want to fetch incoming references."
},
{
"name": "fl",
"value": "",
"type": "query",
"description": "The fields that you can specify in the `fl` parameter are similar to the `fl` query parameters in `/authoring/v1/search` API. You can use the `fl` parameter only if you are also using the `include=metadata` parameter. For example, to retrieve all the document for each of the references use `fl=document`. If the field is not specified, the default fields are returned. The `id` field is always returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Use the 'include' parameter to add options to references that you fetch for an item. Currently, the only available option is `metadata`. When you use the `metadata` option in the `include` parameter, the returned code includes metadata about each of the references that are returned. The information that is returned can be controlled by using the `fl` parameter."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of references to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of references to return in a single result. The current maximum value is 250."
}
]
},
"docs": "Use the `/references/incoming/{classification}/{id}` endpoint to retrieve the incoming references for an item with the provided ID.\n\n ### Examples: ###\n #### A simple lookup of the incoming references for one item ####\n\n ##### Request: #####\n ~~~\n \"{baseURL}/authoring/v1/references/incoming/content-type/cad2e430-beed-40d0-bb57-1c86c4f912c0\"\n ~~~\n ##### Response: #####\n ~~~\n {\n \"offset\": 0,\n \"limit\": 200,\n \"href\": \"/authoring/v1/references/incoming/content-type/cad2e430-beed-40d0-bb5"
}
]
},
{
"info": {
"name": "Authoring renditions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all renditions in the database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/renditions",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of renditions to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of renditions to return in a single result."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the rendition fields that are specified here are returned for each result. Any renditions field is a valid value and these can be specified in a comma-separated list. For example, to list the renditions fields name and ID, provide the value ID, and name. All renditions fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Additional renditions fields that are specified here are returned. Currently, only the links field can be included. Fields are to be provided as a comma-separated list."
}
]
},
"docs": "Use this endpoint to list all the renditions in the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create a new rendition.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/renditions",
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the rendition fields that are specified here are returned for each result. Any renditions field is a valid value and these can be specified in a comma-separated list. For example, to list the renditions fields name and ID, provide the value ID, and name. All renditions fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Additional renditions fields that are specified here are returned. Currently, only the links field can be included. Fields are to be provided as a comma-separated list."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "The id of the project that the rendition's underlying asset resides in. This property must be provided if the asset is in a project. This includes projects with id of \"draft\"."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to create a new rendition. The rendition will have resizing parameters applied before the crop is conducted. The generated rendition link will depend on the parameters provided. The scale parameter is required to resize. LocationX, locationY, width and height parameters are required to crop.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve an existing rendition.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/renditions/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the rendition that you want to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the rendition fields that are specified here are returned for each result. Any renditions field is a valid value and these can be specified in a comma-separated list. For example, to list the renditions fields name and ID, provide the value ID, and name. All renditions fields are returned by default."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Additional renditions fields that are specified here are returned. Currently, only the links field can be included. Fields are to be provided as a comma-separated list."
}
]
},
"docs": "Use this endpoint to retrieve an existing rendition from the database. Access the rendition applied through the media link. The generated rendition link will depend on the parameters provided. The scale parameter is required to resize. LocationX, locationY, width and height parameters are required to crop.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all renditions created within the specified date range.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/renditions/views/by-created",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the rendition was created. Renditions that were created on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the rendition was created. Renditions that were created on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the rendition fields that are specified here are returned for each result. Any rendition field is a valid value and these can be specified in a comma-separated list. For example, to list the rendition fields ID and resource, provide the value resource fields = ID, resource. All rendition fields are returned by default."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of renditions to skip from the beginning of the list and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of renditions to return in a single result. The default value is 50."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the renditions to be returned in ascending or descending order. Documents are returned in descending order by default."
}
]
},
"docs": "Use this endpoint to retrieve all renditions that was created within the date range specified.
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring image profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all image profiles in the database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/image-profiles",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of image profiles to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of image profiles that are returned."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the image profiles to be returned in ascending/alphabetical (default) or descending/reverse-alphabetical order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the image profile fields that are specified here are returned for each result. Any image profile field is a valid value and can be specified as a comma-separated list."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specifies additional fields to include with each result.\nValid options are:\n * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.\n"
}
]
},
"docs": "Use the /image-profiles endpoint to retrieve all image profiles from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create new image profiles.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/image-profiles",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /image-profiles end-point to create a new image profile.
User roles: admin, manager"
},
{
"info": {
"name": "Retrieve the total number of image profiles.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/image-profiles/count"
},
"docs": "Use the /image-profiles/count endpoint to obtain the total number of image profiles within the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve an existing image profile.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/image-profiles/:id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the image profile to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list that when specified, limits the fields returned to just those specified. Any type document field is a valid value."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n * metadata: Adds additional details such as creator and last modifier to the response.\n * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
}
]
},
"docs": "Use the /image-profiles/{id} end-point to retrieve an existing image profile from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing image profile.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/image-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the image profile document to update."
},
{
"name": "forceOverride",
"value": "",
"type": "query",
"description": "Specifies whether revision checking should be disabled."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /image-profiles/{id} end-point to update an existing image profile within the database.
User roles: admin, manager"
},
{
"info": {
"name": "Delete an existing image profile.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/image-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the image profile to delete."
}
]
},
"docs": "Use the /image-profiles/{id} endpoint to delete an existing image profile from the database.
User roles: admin, manager"
},
{
"info": {
"name": "Retrieve all image profiles in the database ordered by last modified date.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/image-profiles/views/by-modified",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the image profiles that you want returned.\nWhen the order is ascending (default), the image profiles that are modified on or after this date and time are returned.\nWhen the order is descending, the image profiles that are modified on or before this date and time are returned.\nThe date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.\n"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the image profiles that you want returned.\nWhen the order is ascending (default), the image profiles that are modified on or before this date and time are returned.\nWhen the order is descending, the image profiles that are modified on or after this date and time are returned.\nThe date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.\n"
},
{
"name": "startId",
"value": "",
"type": "query",
"description": "If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId.\n"
},
{
"name": "endId",
"value": "",
"type": "query",
"description": "If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId.\n"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of image profiles to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of image profiles that are returned."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the image profiles to be returned in ascending/oldest-first (default) or descending/newest-first order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the image profile fields that are specified here are returned for each result. Any image profile field is a valid value and can be specified as a comma-separated list."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specifies additional fields to include with each result.\nValid options are:\n * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.\n"
}
]
},
"docs": "Use the /image-profiles/views/by-modified endpoint to retrieve all image profiles from the database and list them in the order of their last modified date.
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring resources",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a new resource.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/resources",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "query",
"description": "Provide a name for the resource that you want to create."
},
{
"name": "md5",
"value": "",
"type": "query",
"description": "Provide the Base64 encoded MD5 checksum of the resource."
}
]
},
"docs": "Use this endpoint to create a new resource with the binary data that is provided in the request body. If the md5 checksum parameter is provided, the uploaded resource is validated against the provided checksum.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve an existing resource.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/resources/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the resource that you want to retrieve."
},
{
"name": "mode",
"value": "",
"type": "query",
"description": "Provide the option to set the response Content-Disposition as an attachment."
},
{
"name": "bypass-cache",
"value": "",
"type": "query",
"description": "Force bypassing intermediate caches by providing a unique token."
}
]
},
"docs": "Use this endpoint to retrieve an existing resource from the database. The media type of the binary is defined in the Content-Type header. Byte serving is supported. The Cache-Control response header is set to expire the resource in a year.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create a resource at the given id.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/resources/:id",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "query",
"description": "Provide a name for the resource that you want to create."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the resource that you want to create."
},
{
"name": "md5",
"value": "",
"type": "query",
"description": "Provide the Base64 encoded MD5 checksum of the resource."
}
]
},
"docs": "Use this end point to create a resource at the required ID with the binary data provided in the request body. If a resource already exists with that id, then the md5 checksum is compared. If it matches, then the request will respond with a 200 OK. If it does not match, a 409 Conflict response is returned. The created resource will be validated against the checksum.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve all resources created within the specified date range.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/resources/views/by-created",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the resource was created. Resources that were created on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ. Note: when reversing the order you do not switch start and end."
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the resource was created. Resources that were created on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ. Note: when reversing the order you do not switch start and end."
},
{
"name": "startId",
"value": "",
"type": "query",
"description": "If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId. Note: when reversing the order you do not switch start and end ids."
},
{
"name": "endId",
"value": "",
"type": "query",
"description": "If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId. Note: when reversing the order you do not switch start and end ids."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of resource items to return in a single result. The default value is 50. You can pass 0 to unset the limit and stream all available results. A streaming parser can be avoided with format=sequence."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of resource items to skip from the beginning of the list and return the rest. Note: large offsets perform poorly. Use start keys to index into large result sets. Also see pageMode."
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify the order of the results.\n * `ascending` - (default) result keys are increasing\n * `descending` - result keys are decreasing\n\nIt is not necessary to switch the start and end keys and ids when reversing the order.\n"
}
]
},
"docs": "Use this endpoint to retrieve all resources that was created within the date range specified.
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring review",
"type": "folder"
},
"items": [
{
"info": {
"name": "Start a review.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/review",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /review endpoint to start a review. Currently, only Assets and Contents can be reviewed.\nThis endpoint updates the status of the items in bulk. Items with the updated status are added in the review model. Check whether the items were successfully added to the review model from the items field in the returned API representation of review model. You can identify the items that failed to update or invalid items by checking the item IDs that are listed in the response header.\n
User role"
},
{
"info": {
"name": "Retrieve an existing review.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/review/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the review that you want to retrieve."
}
]
},
"docs": "Use the /review/{id} endpoint to retrieve an existing review that matches the ID that is specified from the database. This endpoint returns the API representation of the requested review.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing review.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/review/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the review that you want to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /review/{id} end point to update an existing review that matches the ID that is specified.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Delete an existing review.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/review/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the review that you want to delete."
}
]
},
"docs": "Use the /review/{id} endpoint to delete an existing review in the database.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Approve items in a review.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/review/:id/approve",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the review that you want to approve."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /review/{id}/approve endpoint to approve items in the specified review. \nThis endpoint approves the items that you specify that were added to the specified review in bulk. For example, if Content A, Content B, and Asset C were added to a review, and you requested approval for Content A and Asset C, then only the items that you requested are approved. Check whether the items were successfully approved from the approvals field in the returned API representation of review model. You can ide"
},
{
"info": {
"name": "Approve all items in a review.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/review/:id/approve-all",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the review that you want to approve."
}
]
},
"docs": "Use the /review/{id}/approve-all endpoint to approve all items in the specified review.\nThis endpoint approves all the items added to the specified review in bulk. For example, if Content A, Content B, and Asset C were added to a review, then all three items in the review are approved. Check whether the items were successfully approved from the approvals field in the returned API representation of review model. You can identify the items that failed to approve by checking the item IDs that are l"
},
{
"info": {
"name": "Complete a review.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/review/:id/complete",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the review that you want to end."
}
]
},
"docs": "Use the /review/end/{id} endpoint to end a review. This endpoint changes the review status to complete. The approved items in the review remain as approved, whereas the status of the unapproved items in the review will change to in progress status.\n
User roles: admin, manager, editor"
}
]
},
{
"info": {
"name": "Authoring search",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search in the authoring collection",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/search",
"params": [
{
"name": "defType",
"value": "",
"type": "query",
"description": "The Solr \"defType\" parameter. Specify \"defType=edismax\" to use the edismax query parser."
},
{
"name": "df",
"value": "",
"type": "query",
"description": "Either the Solr \"df\" or \"qf\" parameter is required. The parameter is supported by the edismax query parser."
},
{
"name": "facet",
"value": "",
"type": "query",
"description": "The Solr \"facet\" parameter enables faceted search. Always set this parameter to true if you are using the other \"facet\" parameters."
},
{
"name": "facet.contains",
"value": "",
"type": "query",
"description": "The Solr \"facet.contains\" parameter returns only facets containing this term."
},
{
"name": "facet.containsIgnoreCase",
"value": "",
"type": "query",
"description": "The Solr \"facet.containsIgnoreCase\" parameter ignores case when the \"facet.contains\" parameter is applied."
},
{
"name": "facet.field",
"value": "",
"type": "query",
"description": "The Solr \"facet.field\" parameter identifies a field to be used as a facet."
},
{
"name": "facet.limit",
"value": "",
"type": "query",
"description": "The Solr \"facet.limit\" parameter specifies a limit for the number of results that are returned for each facet. Default value is 100."
},
{
"name": "facet.offset",
"value": "",
"type": "query",
"description": "The Solr \"facet.offset\" parameter specifies an offset into the facet results that are returned and can be used for paging facet results. Default value is 0."
},
{
"name": "facet.prefix",
"value": "",
"type": "query",
"description": "The Solr \"facet.prefix\" parameter returns only facets with this prefix."
},
{
"name": "facet.range",
"value": "",
"type": "query",
"description": "The Solr \"facet.range\" parameter."
},
{
"name": "facet.range.end",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.end\" parameter."
},
{
"name": "facet.range.gap",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.gap\" parameter."
},
{
"name": "facet.range.start",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.start\" parameter."
},
{
"name": "fl",
"value": "",
"type": "query",
"description": "The Solr \"fl\" parameter defines the fields that are returned in the response. By default, the search service returns all fields that are highlighted in the \"Stored\" column of the table at the beginning of this document."
},
{
"name": "fq",
"value": "",
"type": "query",
"description": "The Solr \"fq\" parameter applies a filter query to the search results."
},
{
"name": "f..",
"value": "",
"type": "query",
"description": "Many \"facet\" parameters can be overridden on a per-field basis using the syntax \"f..=\". For example, to specify a general limit of 10 terms for all facet fields and a specific limit of 5 terms for only the \"category\" facet field, use \"facet.limit=10\" and \"f.category.facet.limit=5\"."
},
{
"name": "indent",
"value": "",
"type": "query",
"description": "If the Solr \"indent\" parameter is not \"off\" and has a non-blank value, then Solr attempts at indenting the XML response such that it is easier to read. The default behavior is not to indent the XML response."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "The Solr \"q\" parameter uses Solr/Lucene standard query syntax."
},
{
"name": "qf",
"value": "",
"type": "query",
"description": "Either the Solr \"df\" or \"qf\" parameter is required. The parameter is supported by the edismax query parser."
},
{
"name": "rows",
"value": "",
"type": "query",
"description": "The Solr \"rows\" parameter controls how many documents are returned at the most, and can be used for paging query results. The default value is 10. The maximum allowed value is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "The Solr \"sort\" parameter controls sorting of the query response. Sorting on not unique fields can cause paging to return duplicate or missing entries in subsequent pages of results. It's recommended to sort by unique field or a combination ex. sort=lastModied desc, status desc."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The Solr \"start\" parameter specifies an offset into the responses, which are returned and can be used for paging query results. Default value is 0."
}
]
},
"docs": "Performs a search query by passing all query parameters to Solr. The supported query parser for the \"defType\" parameter can be \"edismax\" or \"lucene\". The query parser name defined in \"q\" or \"fq\" parameter through \"{! ...}\" can have the value \"join\", \"lucene\", \"edismax\", or \"geofilt\". For more information about the query syntax and the available query parameters, see the Solr documentation.\n\n### ***Limitation of sort and pagination*** ###\n\nSorting on not unique fields can cause pagin"
},
{
"info": {
"name": "Search in the authoring collection using post request with json body",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/search/json"
},
"docs": "The request body contains an json object with search query\n
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring sites",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get list of all sites",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/sites",
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned site metadata down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string.\nTo only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`.\n"
}
]
},
"docs": "Returns a list of all sites. A default site with id 'default' exists out of the box.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create a new site",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/sites",
"params": [
{
"name": "copySourceSiteId",
"value": "",
"type": "query",
"description": "If ‘copySourceSiteId’ is specified when creating a site then a new site is created and all the pages from the source site are copied into the new site.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to create a new site.\n\nThe new site can either be an initial draft site which has no associated ready version or\nit can be a draft of an existing ready site.\n\nThe body of the request should contain the metadata for the new site.\nThis metadata should include the site 'name', 'linkedDocId' is optional, 'id' is optional.\nIf 'linkedDocId' is provided, then the site created will be a draft of the ready site specified in 'linkedDocId'.\nIf 'linkedDocId' is not provided, then the site "
},
{
"info": {
"name": "Retrieve metadata for a site.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Optional. Only the site metadata fields that are specified here are returned for each result. Any site metadata field is a valid value and can be specified as a comma-separated list. Field names should only be specified once in the list.\n\nFor example, to only retrieve `name` and `rev` this parameter should look like `fields=name,rev`.\n"
}
]
},
"docs": "Retrieve the site metadata for an existing site. A default site with ID 'default' exists out-of-the-box.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update metadata for a site.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "forceOverride",
"value": "",
"type": "query",
"description": "Force update of the existing site metadata without requiring the current `rev` value.\nWhen set to `true` this request will overwrite the stored site metadata regardless of a difference in revisions.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the metadata for an existing site. A default site with ID 'default' exists out-of-the-box.\n\nThe update data must include the `rev` and `name` metadata fields.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Delete a site and the site pages",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
}
]
},
"docs": "Use this endpoint to delete a site and the pages in that site.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Promote the site and pages metadata from draft to ready status.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/ready",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the draft site."
}
]
},
"docs": "Use this endpoint to change the status of a site's metadata and the metadata of all pages in the site from draft to ready.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Cancel the draft site metadata undoing any modifications.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/cancel",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the draft site."
}
]
},
"docs": "Use this endpoint to undo changes to the site's metadata.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Bulk promote the specified page Ids in the specified site from draft to ready status.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages/ready",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the draft site."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to change the status of multiple pages in a specific site from draft to ready.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Get the full page hierarchy for a site.\n",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned page metadata down to just the specified fields in the returned page hierarchy. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result. The following fields can be specified to be included in the page item: 'hierarchicalPath', 'route'.\nYou can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route.\nThe hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.\n"
},
{
"name": "responseFormat",
"value": "",
"type": "query",
"description": "Specify the format for the response. Valid values are 'hierarchical' and 'list'. Default is 'hierarchical'."
}
]
},
"docs": "Use this endpoint to retrieve the full page hierarchy for site. The metadata for each page will be included. This metadata includes the position of the page relative to its peers, the ID for the page content item, an optional override layout ID to use and encoded route if query parameter included=route is specified.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create a page.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "cloneContentId",
"value": "",
"type": "query",
"description": "Clone the provided content item and to use the clone for this new page.\nIf 'contentId' is set on the body, it is ignored and replaced with the id of the newly cloned content Item\nA non zero length value for 'contentTypeId' in the body must be specified to satisify the API requirements.\n"
},
{
"name": "copySourcePageId",
"value": "",
"type": "query",
"description": "If ‘copySourcePageId’ is specified when creating a page then a new page is created by making a deep copy of the source page and its content.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to create a page in a specified site. The body of the request should contain the metadata for the new page.\nThis metadata should include the page 'name', optional 'position' relative to its peers and the 'contentId' or 'contentTypeId'.\nSpecify 'contentId' to associate an existing content item with the page or specify 'contentTypeId' to create an empty content item using the specified content type.\nThe 'position' field is optional, value is an integer value starting at 0. If not"
},
{
"info": {
"name": "Get pages modified between two dates.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages/views/by-modified",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the page items that you want returned. The page items that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the page items that you want returned. The page items that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned page metadata down to just the specified fields in the returned page hierarchy. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the page items to be returned in ascending or descending order.\nDocuments are returned in ascending order by default.\nSupported order values are 'asc', 'ascending', 'desc' and 'descending'\ne.g. /sites/dummySitesId/pages/views/by-modified?order=descending returns the pages in descending order.\n"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the maximum number of items to return in a single result. The default value is 50. Use 0 for unlimited. If offset and limit are not set, all results are returned."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of items to skip from the beginning of the list and return the rest. The default value is 0. If offset and limit are not set, all results are returned."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result. The following fields can be specified to be included in the page item: 'hierarchicalPath', 'route'.\nYou can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route.\nThe hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.\n"
}
]
},
"docs": "Returns the page metadata for pages modified between the specified last modified date range in the site specified by `site-id`.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Get a page by id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages/:page-id",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "page-id",
"value": "",
"type": "path",
"description": "ID of page."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned page metadata down to just the specified fields.\nFields specified by a comma seperated list of field names and should only be used once in query string.\nTo only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`.\n"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result. The following fields can be specified to be included in the page item: 'hierarchicalPath', 'route'.\nYou can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route.\nThe hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.\n"
}
]
},
"docs": "Returns the page metadata specified by `page-id` in the site specified by `site-id`.\n\nIf the page is a root page then no parentId will be returned in the response.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update a page.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages/:page-id",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "page-id",
"value": "",
"type": "path",
"description": "ID of page."
},
{
"name": "forceOverride",
"value": "",
"type": "query",
"description": "Force update of the existing page metadata without requiring the current rev value.\nWhen set to `true` this request will overwrite the stored page metadata regardless of a difference in revisions.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the page metadata specified by `page-id` in the site specified by `site-id`.\nMove of a page to a different parent or repositioning with other sibling pages is not supported, use the move endpoint instead.\nThe full page metadata must be supplied, partial updates are not supported.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Delete a page.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages/:page-id",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "page-id",
"value": "",
"type": "path",
"description": "ID of page."
},
{
"name": "delete-content",
"value": "",
"type": "query",
"description": "Set to true to delete associated content. If delete-content is not specified the default is to not delete the associated content."
}
]
},
"docs": "Deletes the page specified by `page-id` and all descendant pages in the site specified by `site-id`.\nBy default the page and descendant pages associated content is not deleted, set 'delete-content' query parameter to 'true' to delete the page and descendant pages associated content.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Move a page.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages/move",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "sourceId",
"value": "",
"type": "query",
"description": "The ID of the source page to move."
},
{
"name": "sourceRev",
"value": "",
"type": "query",
"description": "the 'rev' value for the page to be moved."
},
{
"name": "targetId",
"value": "",
"type": "query",
"description": "The ID of the target page."
},
{
"name": "targetRev",
"value": "",
"type": "query",
"description": "the 'rev' value for the target page."
},
{
"name": "targetPosition",
"value": "",
"type": "query",
"description": "The new position on the target page for the move."
}
]
},
"docs": "Use this endpoint to move a page. The body of the request should be empty.\nThe query parameters should include the 'sourceId', 'sourceRev', 'targetPosition', the optional 'targetId' and 'targetRev'.\n`sourceId` and `sourceRev` relate to the page to be moved.\n`targetId` and `targetRev` relate to the destination parent page. These are optional parameters, if not set it means the source page is to be moved to the site root.\nThe `targetPosition` field is required, it is an integer value starting at "
},
{
"info": {
"name": "Promote the page from draft to ready status.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/sites/:site-id/pages/:page-id/ready",
"params": [
{
"name": "site-id",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "page-id",
"value": "",
"type": "path",
"description": "The ID of the draft page."
}
]
},
"docs": "Use this endpoint to change the status of a page from draft to ready.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Get a page by unique id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/sites/pages/:page-id",
"params": [
{
"name": "page-id",
"value": "",
"type": "path",
"description": "ID of page."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned page metadata down to just the specified fields.\nFields specified by a comma seperated list of field names and should only be used once in query string.\nTo only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`.\n"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result. The following fields can be specified to be included in the page item: 'hierarchicalPath', 'route'.\nYou can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route.\nThe hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.\n"
}
]
},
"docs": "Returns the page metadata specified by unique `page-id`. This API is equalivent to `/sites/pages/{site-id/pages{page-id}` but does not require a `site-id`.\n\nIf the page is a root page then no parentId will be returned in the response.\n
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring types",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all type documents in the database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of type documents to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of type documents that are returned."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the type documents to be returned in ascending/alphabetical (default) or descending/reverse-alphabetical order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content type fields that are specified here are returned for each result. Any type document field is a valid value and can be specified as a comma-separated list."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result.\nValid options are:\n * links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.\n * all: Adds all current and future additional fields to the response.\n\nWhen used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.\n"
}
]
},
"docs": "Use the /types endpoint to retrieve all content type documents from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Create new type documents.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/types",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /types end-point to create a new type document.\n## Example elements\n### Category element\n```\n{\n \"key\": \"MyCategoryElement\",\n \"label\": \"My Category Element\",\n \"elementType\": \"category\",\n \"restrictedParents\": [\"63b5f83684cddba687cb41eca328a41a\"],\n - Optional. Indicates that categories can only been chosen from the specified parent. Currently only supports a single entry.\n \"searchKey\": \"string1\" | \"string2\" | \"string3\" | \"string4\" | \"sortableString1\" | \"sortableString2\" | \"so"
},
{
"info": {
"name": "Retrieve an existing type by its path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types/by-path",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "path",
"value": "",
"type": "query",
"description": "The path of the content type to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list that when specified, limits the fields returned to just those specified. Any type document field is a valid value."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result.\nValid options are:\n * links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.\n * metadata: Adds additional details such as creator and last modifier to the response.\n * schema: Adds the 'schema' section to the response.\n * mappings: Add the 'mappings' section to the response.\n * all: Adds all current and future additional fields to the response.\n\nWhen used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.\n"
}
]
},
"docs": "Use the /types/by-path end-point to retrieve an existing content type from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve the total number of types.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types/count"
},
"docs": "Use the /types/count endpoint to obtain the total number of content types within the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve an existing type.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types/:id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content type document that you want to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content type fields that are specified here are returned for each result. Any type document field is a valid value and can be specified as a comma-separated list."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result.\nValid options are:\n * links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.\n * metadata: Adds additional details such as creator and last modifier to the response.\n * schema: Adds the 'schema' section to the response.\n * mappings: Add the 'mappings' section to the response.\n * all: Adds all current and future additional fields to the response.\n\nWhen used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.\n"
}
]
},
"docs": "Use the /types/{id} end-point to retrieve an existing content type from the database.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Update an existing type.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/authoring/v1/types/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content type document that you want to update."
},
{
"name": "forceOverride",
"value": "",
"type": "query",
"description": "Specifies whether revision checking should be disabled."
},
{
"name": "options",
"value": "",
"type": "query",
"description": "Specify additional update directives.\nValid directives are:\n * rebuild-path-filename: Instructs the service to re-generate the last fragment of the specified document path, by converting the specified document name into a filesystem friendly filename.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /types/{id} end-point to update an existing content type within the database.
User roles: admin, manager"
},
{
"info": {
"name": "Delete an existing type.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/authoring/v1/types/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content type document that you want to delete."
},
{
"name": "cascade",
"value": "",
"type": "query",
"description": "Lists the associated artifacts that should be deleted at the same time.\nValid options are:\n * mappings: Deletes the associated layout-mapping.\n"
}
]
},
"docs": "Use the /types/{id} endpoint to delete an existing content type from the database.
User roles: admin, manager"
},
{
"info": {
"name": "Copies an existing type.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/types/:id/copy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content type document that you wish to copy."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "An optional name to associate with the copy. If there is an existing content-type with the specified name, then the copied document will have a name in the format 'Copy [NUMBER] of [NAME]'"
},
{
"name": "cascade",
"value": "",
"type": "query",
"description": "Lists the associated artifacts that should be copied at the same time.\nValid options are:\n * mappings: Also copies layout-mapping associated with the original content type.\n * defaults: Also copies default-content associated with the original content type.\n * all : Copies mappings as well as defaults.\n"
}
]
},
"docs": "Use the /types/{id}/copy end-point to create a duplicate of a content type document. The new type will have a name in the format 'Copy [NUMBER] of [SOURCE-NAME]'
User roles: admin, manager"
},
{
"info": {
"name": "Returns a skeleton content item based on the specified content-type.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types/:id/new-content",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content type document that you wish to generate the content against."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional information to include on the content item.\nValid options are:\n* values: Adds empty value attributes to each content element. Note that some empty values, such as `id=\"\"`, may not pass content validation.\n* defaults: Attempts to add default values to each content element. If this is set but `defaultContentId` is not specified, elements may be populated from a default-content item matching the specified type.\n If both defaults and values are requested (e.g. `include=all` or `include=values,defaults`), empty value attributes will be added for elements that were not found on the default content.\n* all: Adds all current and future additional information to the response.\n"
},
{
"name": "defaultContentId",
"value": "",
"type": "query",
"description": "Specify a default content item to populate the generated content. If provided, and the item exists, elements and other fields will be copied across to the returned content item.\n"
},
{
"name": "valuesForGroup",
"value": "",
"type": "query",
"description": "if element is group - returns in the response payload value/values and typeRef \nif element is NOT group - returns value/values only if defaults elements are defined\n"
}
]
},
"docs": "Use the /types/{id}/new-content end-point to create a new content item applicable for the specified content type document.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve the Json-Schema representation of the document.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types/:id/schema",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content type document for which you need to get the Json-Schema."
}
]
},
"docs": "Use the /types/{id}/schema end-point to get the Json-Schema of a content type document. Use the Json-Schema to validate content item documents that are created from this content type document.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Validate the supplied type document instance (eg. content item) against the specified type.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/types/:id/validate",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the content type document that you want to validate against."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /types/{id}/validate end-point to validate if the content items specified match the content type document provided.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve a blank content type.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types/new",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
]
},
"docs": "Use the /types/new end-point to get a blank content type document.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all type documents in the database ordered by last modified date.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types/views/by-modified",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the content types that you want returned.\nWhen the order is ascending (default), the content types that are modified on or after this date and time are returned.\nWhen the order is descending, the content types that are modified on or before this date and time are returned.\nThe date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.\n"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Provide the date and time of when the last modifications were made to the content types that you want returned.\nWhen the order is ascending (default), the content types that are modified on or before this date and time are returned.\nWhen the order is descending, the content types that are modified on or after this date and time are returned.\nThe date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.\n"
},
{
"name": "startId",
"value": "",
"type": "query",
"description": "If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId.\n"
},
{
"name": "endId",
"value": "",
"type": "query",
"description": "If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId.\n"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of type documents to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of type documents that are returned."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
},
{
"name": "pageMode",
"value": "",
"type": "query",
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the type documents to be returned in ascending/oldest-first (default) or descending/newest-first order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content type fields that are specified here are returned for each result. Any type document field is a valid value and can be specified as a comma-separated list."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result.\nValid options are:\n * links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.\n * all: Adds all current and future additional fields to the response.\n\nWhen used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.\n"
}
]
},
"docs": "Use the /types/views/by-modified endpoint to retrieve all type documents from the database and list them in the order of their last modified date.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve all types in the database with the specified name.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/types/views/by-name",
"params": [
{
"name": "name",
"value": "",
"type": "query",
"description": "The name to query."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of types to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of types that are returned."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content type fields that are specified here are returned for each result. Any type document field is a valid value and can be specified as a comma-separated list."
},
{
"name": "format",
"value": "",
"type": "query",
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
}
]
},
"docs": "Use the /types/views/by-name endpoint to retrieve all types from the database with the specified name.
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve an existing element definition.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/elementdefs/:id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the element definition that you want to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the element definition fields that are specified here are returned for each result. Any element definition field is a valid value and can be specified as a comma-separated list."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result.\nValid options are:\n * links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.\n * all: Adds all current and future additional fields to the response.\n\nWhen used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.\n"
}
]
},
"docs": "Use the /elementdefs/{id} end-point to retrieve an existing element definition from the database.\n\nEach element definition describes a variety of element that can be added to a content type.\n\nTo programmatically create a content-type, merge the 'elementFragment' attribute into the 'elements' attribute of the type, performing the following replacements:\n '$ELEMENT_KEY$': With the desired element key\n '$ELEMENT_LABEL$': With the desired element label\n
User roles: admin, manager, editor, vie"
},
{
"info": {
"name": "Retrieve all element definitions in the database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/elementdefs",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Use the offset parameter to specify the number of element definitions to skip and return the rest."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Set the limit for the number of element definitions that are returned."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Specify whether you want the element definitions to be returned in ascending or descending order."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the element definition fields that are specified here are returned for each result. Any element definition field is a valid value and can be specified as a comma-separated list."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify additional fields to include with each result.\nValid options are:\n * links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.\n * all: Adds all current and future additional fields to the response.\n\nWhen used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.\n"
}
]
},
"docs": "Use the /elementdefs endpoint to retrieve all element definitions from the database.\n\nEach element definition describes a variety of element that can be added to a content type.\n\nTo programmatically create a content-type, merge the 'elementFragment' attribute into the 'elements' attribute of the type, performing the following replacements:\n '$ELEMENT_KEY$': With the desired element key\n '$ELEMENT_LABEL$': With the desired element label\n
User roles: admin, manager, editor, viewer"
}
]
},
{
"info": {
"name": "Authoring version",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all versions for the specified authoring item.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/versions/:classification/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the authoring item that you want to retrieve versions for."
},
{
"name": "classification",
"value": "",
"type": "path",
"description": "Provide the classification of the authoring item that you want to retrieve versions for."
}
]
},
"docs": "Use the /versions/{classification}/{id} endpoint to retrieve all the versions for the specified authoring item.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Retrieve a specific version for a specific authoring item.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/versions/:classification/:id/:timestamp",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the authoring item that you want to retrieve a version for."
},
{
"name": "classification",
"value": "",
"type": "path",
"description": "Provide the classification of the authoring item that you want to retrieve a version for."
},
{
"name": "timestamp",
"value": "",
"type": "path",
"description": "Provide the ISO-8601 timestamp of the version that you want to retrieve."
}
]
},
"docs": "Use the /versions/{classification}/{id}/{timestamp} endpoint to retrieve a specific version for the specified authoring item.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Restore a versioned item - currently supported for content and assets.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/versions/restore",
"params": [
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Optional projectId that the item belongs to."
}
]
},
"docs": "Use this endpoint to restore a specific version of a content or an asset item by sending the JSON payload as the request body. The restored item will always be a draft - overwriting an existing one or creating a new one. Link to the new draft is sent as a response-header `Location`.\n
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve the current version policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/versions/policy"
},
"docs": "Use this endpoint to fetch the current version policy that determines how specific documents are versioned in the authoring system.\nOnly the policy status is being returned at this point.\n
User roles: admin, manager, editor, viewer"
},
{
"info": {
"name": "Turn on the version-policy.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/versions/policy/on"
},
"docs": "Use this endpoint to turn on the version-policy.
User roles: admin"
},
{
"info": {
"name": "Turn off the version-policy.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/versions/policy/off"
},
"docs": "Use this endpoint to turn off the version-policy. It will also trigger the version clean-up.
User roles: admin"
},
{
"info": {
"name": "Disable the version-policy.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/authoring/v1/versions/policy/disable"
},
"docs": "Use this endpoint to disable the version-policy.
User roles: admin"
}
]
},
{
"info": {
"name": "Authoring context search",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve contextual search results from the authoring collection.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/authoring/v1/contextualsearch",
"headers": [
{
"name": "accept-language",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Use the filter parameter to specify the type of contextual filters to apply, it can be used multiple times to apply multiple filters."
},
{
"name": "position",
"value": "",
"type": "query",
"description": "Provide the center point for a proximity search by using the format \"latitude,longitude\"."
},
{
"name": "distance",
"value": "",
"type": "query",
"description": "Provide the value for distance that specifies the bounding radius around the location. The default value is 5."
},
{
"name": "metric",
"value": "",
"type": "query",
"description": "Provide the metric that is used for the distance value.\nAcceptable values are km (kilometers) and mi (miles).\nThe default value is km.\n"
},
{
"name": "similar-source-id",
"value": "",
"type": "query",
"description": "Provide the ID (uuid) of the item on which to base the `similar` search. \nThis parameter is required if the filter to be applied is `similar`.\n"
},
{
"name": "similar-source-classification",
"value": "",
"type": "query",
"description": "Provide the classification of the item on which to base the `similar` search. \nFor example, to specify an asset classification, use \"asset\". \nThis parameter is required if the filter to be applied is `similar`.\n"
},
{
"name": "df",
"value": "",
"type": "query",
"description": "Either the Solr \"df\" or \"qf\" parameter is required. The parameter is supported by the edismax query parser."
},
{
"name": "defType",
"value": "",
"type": "query",
"description": "The Solr \"defType\" parameter. Specify defType=edismax to use the edismax query parser."
},
{
"name": "facet",
"value": "",
"type": "query",
"description": "The Solr \"facet\" parameter enables faceted search. Always set this parameter to true if you are using the other \"facet\" parameters."
},
{
"name": "facet.contains",
"value": "",
"type": "query",
"description": "The Solr \"facet.contains\" parameter returns only facets that contain this term."
},
{
"name": "facet.containsIgnoreCase",
"value": "",
"type": "query",
"description": "The Solr \"facet.containsIgnoreCase\" parameter ignores case when the \"facet.contains\" parameter is applied."
},
{
"name": "facet.field",
"value": "",
"type": "query",
"description": "The Solr \"facet.field\" parameter identifies a field to be used as a facet."
},
{
"name": "facet.limit",
"value": "",
"type": "query",
"description": "The Solr \"facet.limit\" parameter specifies a limit for the number of results that are returned for each facet. Default value is 100."
},
{
"name": "facet.offset",
"value": "",
"type": "query",
"description": "The Solr \"facet.offset\" parameter specifies an offset into the facet results that are returned and can be used for paging facet results. Default value is 0."
},
{
"name": "facet.prefix",
"value": "",
"type": "query",
"description": "The Solr \"facet.prefix\" parameter returns only facets with this prefix."
},
{
"name": "facet.range",
"value": "",
"type": "query",
"description": "The Solr \"facet.range\" parameter."
},
{
"name": "facet.range.gap",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.gap\" parameter."
},
{
"name": "facet.range.start",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.start\" parameter."
},
{
"name": "facet.range.end",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.end\" parameter."
},
{
"name": "fl",
"value": "",
"type": "query",
"description": "The Solr \"fl\" parameter defines the fields that are returned in the response. By default, the search service returns all fields."
},
{
"name": "fq",
"value": "",
"type": "query",
"description": "The Solr \"fq\" parameter applies a filter query to the search results."
},
{
"name": "f..",
"value": "",
"type": "query",
"description": "Many facet parameters can be overridden on a per-field basis by using the syntax \"f..=\". For example, to specify a general limit of 10 terms for all facet fields and a specific limit of five terms for only the \"category\" facet field, use \"facet.limit=10\" and \"f.category.facet.limit=5\"."
},
{
"name": "indent",
"value": "",
"type": "query",
"description": "If the Solr \"indent\" parameter is not \"off\" and has a non-blank value, then Solr attempts to indent the XML response such that it is easier to read. The default behavior is not to indent the XML response."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "The Solr \"q\" parameter uses Solr/Lucene standard query syntax."
},
{
"name": "qf",
"value": "",
"type": "query",
"description": "The Solr \"qf\" parameter is supported by the dismax or edismax query parser."
},
{
"name": "rows",
"value": "",
"type": "query",
"description": "The Solr \"rows\" parameter controls how many documents are returned at the most, and can be used for paging query results. The default value is 10. The maximum allowed value is 1000."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The Solr \"start\" parameter specifies an offset into the responses which are returned and can be used for paging query results. Default value is 0."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "The Solr \"sort\" parameter controls sorting of the query response. Sorting on not unique fields can cause paging to return duplicate or missing entries in subsequent pages of results. It's recommended to sort by unique field or a combination ex. sort=lastModied desc, status desc."
}
]
},
"docs": "Use the /authoring/v1/contextualsearch endpoint to retrieve contextual search results from the authoring collection based on the passed filters.\nSee the Authoring Search documents on the Content API for details of the main search service parameters.\n#### Current filters\n* `accept-language` Searches for content with matching languages. If this filter is specified the `accept-language` request header must be specified with the ordered list of languages to search with. The search iterates through a"
}
]
},
{
"info": {
"name": "Delivery context search",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve contextual search results from the delivery collection",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/contextualsearch",
"headers": [
{
"name": "accept-language",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Use the filter parameter to specify the type of contextual filters to apply, it can be used multiple times to apply multiple filters."
},
{
"name": "position",
"value": "",
"type": "query",
"description": "Provide the center point for a proximity search by using the format \"latitude,longitude\"."
},
{
"name": "distance",
"value": "",
"type": "query",
"description": "Provide the value for distance that specifies the bounding radius around the location. The default value is 5."
},
{
"name": "metric",
"value": "",
"type": "query",
"description": "Provide the metric that is used for the distance value.\nAcceptable values are km (kilometers) and mi (miles).\nThe default value is km.\n"
},
{
"name": "similar-source-id",
"value": "",
"type": "query",
"description": "Provide the ID (uuid) of the item on which to base the `similar` search. \nThis parameter is required if the filter to be applied is `similar`.\n"
},
{
"name": "similar-source-classification",
"value": "",
"type": "query",
"description": "Provide the classification of the item on which to base the `similar` search. \nFor example, to specify an asset classification, use \"asset\". \nThis parameter is required if the filter to be applied is `similar`.\n"
},
{
"name": "df",
"value": "",
"type": "query",
"description": "Either the Solr \"df\" or \"qf\" parameter is required. The parameter is supported by the edismax query parser."
},
{
"name": "defType",
"value": "",
"type": "query",
"description": "The Solr \"defType\" parameter. Specify defType=edismax to use the edismax query parser."
},
{
"name": "facet",
"value": "",
"type": "query",
"description": "The Solr \"facet\" parameter enables faceted search. Always set this parameter to true if you are using the other \"facet\" parameters."
},
{
"name": "facet.contains",
"value": "",
"type": "query",
"description": "The Solr \"facet.contains\" parameter returns only facets that contain this term."
},
{
"name": "facet.containsIgnoreCase",
"value": "",
"type": "query",
"description": "The Solr \"facet.containsIgnoreCase\" parameter ignores case when the \"facet.contains\" parameter is applied."
},
{
"name": "facet.field",
"value": "",
"type": "query",
"description": "The Solr \"facet.field\" parameter identifies a field to be used as a facet."
},
{
"name": "facet.limit",
"value": "",
"type": "query",
"description": "The Solr \"facet.limit\" parameter specifies a limit for the number of results that are returned for each facet. Default value is 100."
},
{
"name": "facet.offset",
"value": "",
"type": "query",
"description": "The Solr \"facet.offset\" parameter specifies an offset into the facet results that are returned and can be used for paging facet results. Default value is 0."
},
{
"name": "facet.prefix",
"value": "",
"type": "query",
"description": "The Solr \"facet.prefix\" parameter returns only facets with this prefix."
},
{
"name": "facet.range",
"value": "",
"type": "query",
"description": "The Solr \"facet.range\" parameter."
},
{
"name": "facet.range.gap",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.gap\" parameter."
},
{
"name": "facet.range.start",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.start\" parameter."
},
{
"name": "facet.range.end",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.end\" parameter."
},
{
"name": "fl",
"value": "",
"type": "query",
"description": "The Solr \"fl\" parameter defines the fields that are returned in the response. By default, the search service returns all fields."
},
{
"name": "fq",
"value": "",
"type": "query",
"description": "The Solr \"fq\" parameter applies a filter query to the search results."
},
{
"name": "f..",
"value": "",
"type": "query",
"description": "Many facet parameters can be overridden on a per-field basis by using the syntax \"f..=\". For example, to specify a general limit of 10 terms for all facet fields and a specific limit of five terms for only the \"category\" facet field, use \"facet.limit=10\" and \"f.category.facet.limit=5\"."
},
{
"name": "indent",
"value": "",
"type": "query",
"description": "If the Solr \"indent\" parameter is not \"off\" and has a non-blank value, then Solr attempts to indent the XML response such that it is easier to read. The default behavior is not to indent the XML response."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "The Solr \"q\" parameter uses Solr/Lucene standard query syntax."
},
{
"name": "qf",
"value": "",
"type": "query",
"description": "The Solr \"qf\" parameter is supported by the dismax or edismax query parser."
},
{
"name": "rows",
"value": "",
"type": "query",
"description": "The Solr \"rows\" parameter controls how many documents are returned at the most, and can be used for paging query results. The default value is 10. The maximum allowed value is 1000."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The Solr \"start\" parameter specifies an offset into the responses which are returned and can be used for paging query results. Default value is 0."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "The Solr \"sort\" parameter controls sorting of the query response. Sorting on not unique fields can cause paging to return duplicate or missing entries in subsequent pages of results. It's recommended to sort by unique field or a combination ex. sort=lastModied desc, status desc."
}
]
},
"docs": "Use the /delivery/v1/contextualsearch endpoint to retrieve contextual search results from the delivery collection based on the passed filters.\nSee the Delivery Search documents on the Content API for details of the main search service parameters.\n#### Current filters\n* `accept-language` Searches for content with matching languages. If this filter is specified the `accept-language` request header must be specified with the ordered list of languages to search with. The search iterates through all "
}
]
},
{
"info": {
"name": "Delivery content",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve filtered content by id in bulk",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/delivery/v1/content/bulk_retrieve",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns an array of requested filtered content items. Restricted content items cannot be accessed.\nTo access those content items too, you have to use /mydelivery/v1/content/bulk_retrieve.\n\nSample request body for retrieving id and title fields of two content items with id '7f2335cc-d91d-4f52-9e26-2d9402e463c0' and '1067771c-ec05-4671-951b-18f503953f2d':\n\n {\n \"ids\": [\"7f2335cc-d91d-4f52-9e26-2d9402e463c0\", \"1067771c-ec05-4671-951b-18f503953f2d\"],\n \"fields\": [\"id\", \"title\"]\n }\n\nFor"
},
{
"info": {
"name": "Retrieve filtered content items by id in bulk, including restricted ones.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/mydelivery/v1/content/bulk_retrieve",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns an array of requested filtered content items. This route is restricted to authenticated users and allows to access restricted content items too.\n\nSample request body for retrieving id and title fields of two content items with id '7f2335cc-d91d-4f52-9e26-2d9402e463c0' and '1067771c-ec05-4671-951b-18f503953f2d':\n\n {\n \"ids\": [\"7f2335cc-d91d-4f52-9e26-2d9402e463c0\", \"1067771c-ec05-4671-951b-18f503953f2d\"],\n \"fields\": [\"id\", \"title\"]\n }\n\nFor each `content item` requested ..\n\n"
},
{
"info": {
"name": "Get content item",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/content/:id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content item."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content item down to just the specified fields. Fields are specified by a comma seperated list of field names and should only be used once in the query string. To only retrieve `rev` and `last-modified` this parameter should look like `fields=rev,last-modified`."
}
]
},
"docs": "Returns the content item specified by `id`. Restricted content items cannot be accessed.\nTo access those content items too, you have to use /mydelivery/v1/content/{id}.\n
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Get content item, including restricted ones.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/mydelivery/v1/content/:id",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content item."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content item down to just the specified fields. Fields are specified by a comma seperated list of field names and should only be used once in the query string. To only retrieve `rev` and `last-modified` this parameter should look like `fields=rev,last-modified`."
}
]
},
"docs": "Returns the content item specified by `id`. This route is restricted to authenticated users and allows to access restricted content items too.\n
User roles: admin, manager, editor, viewer, authenticatedVisitor"
}
]
},
{
"info": {
"name": "Delivery render",
"type": "folder"
},
"items": [
{
"info": {
"name": "Applies server side rendering to the specified content item",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/rendering/render/content/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the resource. Note that IDs are always the IDs of published item, even if a draft exists with a different ID. For a site, use `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "layoutId",
"value": "",
"type": "query",
"description": "Provide the ID of the layout to be used to pre-render the resource."
},
{
"name": "contentType",
"value": "",
"type": "query",
"description": "Specifies the content type to be set on the response. Default is text/html."
},
{
"name": "callback",
"value": "",
"type": "query",
"description": "Provide the JSONP callback name for JSONP support. The callback name must designate a javascript function that can be executed in the global scope. The argument will be the deserialized JSON object."
},
{
"name": "rcParam",
"value": "",
"type": "query",
"description": "By specifying query parameters with arbitrary names, but start with the prefix 'rc' or 'RC' (case insensitive), e.g., 'RcParam1', 'rcMy', you can provide custom parameters that will be added to the rendering context JSON under the $context.customParameters section."
}
]
},
"docs": "Applies server side rendering to the specified content item
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Delivery Site By ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/rendering/sites/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the resource. Note that IDs are always the IDs of published item, even if a draft exists with a different ID. For a site, use `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "callback",
"value": "",
"type": "query",
"description": "Provide the JSONP callback name for JSONP support. The callback name must designate a javascript function that can be executed in the global scope. The argument will be the deserialized JSON object."
}
]
},
"docs": "Provides delivery site information including site metadata and pages hierarchy
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Delivery Rendering Context By ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/rendering/context/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the resource. Note that IDs are always the IDs of published item, even if a draft exists with a different ID. For a site, use `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "callback",
"value": "",
"type": "query",
"description": "Provide the JSONP callback name for JSONP support. The callback name must designate a javascript function that can be executed in the global scope. The argument will be the deserialized JSON object."
}
]
},
"docs": "Use the `rendering/context/{id}` endpoint to retrieve the rendering context for the specified content ID.\n\nThe response contains the delivery content structure with resolved content element references. The resolution replaces content elements of type reference with the referenced rendering context. It is resolved recursively if the resolved content structure contains content elements of type reference.\n\n\n**Cycle detection**\n\nReferenced content can have cycles. In a cyclic structure, references l"
},
{
"info": {
"name": "Aggregated type information by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/rendering/type/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the resource. Note that IDs are always the IDs of published item, even if a draft exists with a different ID. For a site, use `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "callback",
"value": "",
"type": "query",
"description": "Provide the JSONP callback name for JSONP support. The callback name must designate a javascript function that can be executed in the global scope. The argument will be the deserialized JSON object."
}
]
},
"docs": "Aggregated type information by ID
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Delivery Rendering Contexts By Search Query",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/rendering/search",
"params": [
{
"name": "q",
"value": "",
"type": "query",
"description": "The Solr \"q\" parameter uses Solr/Lucene standard query syntax."
},
{
"name": "fq",
"value": "",
"type": "query",
"description": "The Solr \"fq\" parameter applies a filter query to the search results."
},
{
"name": "callback",
"value": "",
"type": "query",
"description": "Provide the JSONP callback name for JSONP support. The callback name must designate a javascript function that can be executed in the global scope. The argument will be the deserialized JSON object."
}
]
},
"docs": "Use the `/delivery/v1/rendering/search` endpoint to retrieve rendering contexts based on a search query. The API has the same query functionality as the delivery search API (See the delivery search API documentation for full query options), except for the following aspects:\n - The \"fl\" (field list) query parameter is ignored.\n - The query supports only classifiction content.\n - The results of the query are rendering contexts (0-*) in any case.\n
User roles: admin, manager, editor, view"
},
{
"info": {
"name": "Applies server side rendering to the specified content item",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/mydelivery/v1/rendering/render/content/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the resource. Note that IDs are always the IDs of published item, even if a draft exists with a different ID. For a site, use `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "layoutId",
"value": "",
"type": "query",
"description": "Provide the ID of the layout to be used to pre-render the resource."
},
{
"name": "contentType",
"value": "",
"type": "query",
"description": "Specifies the content type to be set on the response. Default is text/html."
},
{
"name": "callback",
"value": "",
"type": "query",
"description": "Provide the JSONP callback name for JSONP support. The callback name must designate a javascript function that can be executed in the global scope. The argument will be the deserialized JSON object."
},
{
"name": "rcParam",
"value": "",
"type": "query",
"description": "By specifying query parameters with arbitrary names, but start with the prefix 'rc' or 'RC' (case insensitive), e.g., 'RcParam1', 'rcMy', you can provide custom parameters that will be added to the rendering context JSON under the $context.customParameters section."
}
]
},
"docs": "Applies server side rendering to the specified content item
User roles: admin, manager, editor, viewer, authenticatedVisitor"
},
{
"info": {
"name": "Aggregated type information by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/mydelivery/v1/rendering/type/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Provide the ID of the resource. Note that IDs are always the IDs of published item, even if a draft exists with a different ID. For a site, use `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "callback",
"value": "",
"type": "query",
"description": "Provide the JSONP callback name for JSONP support. The callback name must designate a javascript function that can be executed in the global scope. The argument will be the deserialized JSON object."
}
]
},
"docs": "Aggregated type information by ID
User roles: admin, manager, editor, viewer, authenticatedVisitor"
}
]
},
{
"info": {
"name": "Delivery resources",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve a resource by path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/resources",
"params": [
{
"name": "path",
"value": "",
"type": "query",
"description": "Provide the absolute path of the resource (URL encoded)."
}
]
},
"docs": "This endpoint retrieves the resource at the given path. Restricted resources cannot be accessed. To access those resources too, you have to use /mydelivery/v1/resources.\nThe resource's path can be obtained using the Authoring assets API: /authoring/v1/assets\n\n {\n \"items\": [\n {\n \"mediaType\": \"image/jpeg\",\n \"name\": \"myPicture.jpg\",\n \"path\": \"/path/to/myPicture.jpg\",\n ...\n\nThe delivery URL for this endpoint would look "
},
{
"info": {
"name": "Retrieve a resource by Id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/resources/:fileIdentifier",
"params": [
{
"name": "fileIdentifier",
"value": "",
"type": "path",
"description": "Provide the resource Id of the resource to be retrieved.\nOptionally, if the extension (e.g. .jpg) is known then it can be appended to the id.\n"
}
]
},
"docs": "This endpoint retrieves the resource for the specified resource Id. Restricted resources cannot be accessed. To access those resources too, you have to use /mydelivery/v1/resources/{fileIdentifier}.\nThe resource's Id can be obtained using the Authoring assets API: /authoring/v1/assets\n\n {\n \"items\": [\n {\n \"resource\": \"06763fa56ceec4d5bcafb37b53de2cd1\",\n ...\n\n\nThe delivery Url for this endpoint would look like:\n\n /delivery/v1/resources/06763fa5"
}
]
},
{
"info": {
"name": "Delivery search",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search in the delivery collection",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/search",
"params": [
{
"name": "defType",
"value": "",
"type": "query",
"description": "The Solr \"defType\" parameter. Specify \"defType=edismax\" to use the edismax query parser."
},
{
"name": "df",
"value": "",
"type": "query",
"description": "Either the Solr \"df\" or \"qf\" parameter is required. The parameter is supported by the edismax query parser."
},
{
"name": "facet",
"value": "",
"type": "query",
"description": "The Solr \"facet\" parameter enables faceted search. Always set this parameter to true if you are using the other \"facet\" parameters."
},
{
"name": "facet.contains",
"value": "",
"type": "query",
"description": "The Solr \"facet.contains\" parameter returns only facets containing this term."
},
{
"name": "facet.containsIgnoreCase",
"value": "",
"type": "query",
"description": "The Solr \"facet.containsIgnoreCase\" parameter ignores case when the \"facet.contains\" parameter is applied."
},
{
"name": "facet.field",
"value": "",
"type": "query",
"description": "The Solr \"facet.field\" parameter identifies a field to be used as a facet."
},
{
"name": "facet.limit",
"value": "",
"type": "query",
"description": "The Solr \"facet.limit\" parameter specifies a limit for the number of results that are returned for each facet. Default value is 100."
},
{
"name": "facet.offset",
"value": "",
"type": "query",
"description": "The Solr \"facet.offset\" parameter specifies an offset into the facet results that are returned and can be used for paging facet results. Default value is 0."
},
{
"name": "facet.prefix",
"value": "",
"type": "query",
"description": "The Solr \"facet.prefix\" parameter returns only facets with this prefix."
},
{
"name": "facet.range",
"value": "",
"type": "query",
"description": "The Solr \"facet.range\" parameter."
},
{
"name": "facet.range.end",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.end\" parameter."
},
{
"name": "facet.range.gap",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.gap\" parameter."
},
{
"name": "facet.range.start",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.start\" parameter."
},
{
"name": "fl",
"value": "",
"type": "query",
"description": "The Solr \"fl\" parameter defines the fields that are returned in the response. By default, the search service returns all fields that are highlighted in the \"Stored\" column of the table at the beginning of this document."
},
{
"name": "fq",
"value": "",
"type": "query",
"description": "The Solr \"fq\" parameter applies a filter query to the search results."
},
{
"name": "f..",
"value": "",
"type": "query",
"description": "Many \"facet\" parameters can be overridden on a per-field basis using the syntax \"f..=\". For example, to specify a general limit of 10 terms for all facet fields and a specific limit of 5 terms for only the \"category\" facet field, use \"facet.limit=10\" and \"f.category.facet.limit=5\"."
},
{
"name": "indent",
"value": "",
"type": "query",
"description": "If the Solr \"indent\" parameter is not \"off\" and has a non-blank value, then Solr attempts at indenting the XML response such that it is easier to read. The default behavior is not to indent the XML response."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "The Solr \"q\" parameter uses Solr/Lucene standard query syntax."
},
{
"name": "qf",
"value": "",
"type": "query",
"description": "Either the Solr \"df\" or \"qf\" parameter is required. The parameter is supported by the edismax query parser."
},
{
"name": "rows",
"value": "",
"type": "query",
"description": "The Solr \"rows\" parameter controls how many documents are returned at the most, and can be used for paging query results. The default value is 10. The maximum allowed value is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "The Solr \"sort\" parameter controls sorting of the query response. Sorting on not unique fields can cause paging to return duplicate or missing entries in subsequent pages of results. It's recommended to sort by unique field or a combination ex. sort=lastModied desc, status desc."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The Solr \"start\" parameter specifies an offset into the responses, which are returned and can be used for paging query results. Default value is 0."
}
]
},
"docs": "Performs a search query by passing all query parameters to Solr. Search results will not contain protected items.\nThe supported query parser for the \"defType\" parameter can be \"edismax\" or \"lucene\". The query parser name defined\nin \"q\" or \"fq\" parameter through \"{! ...}\" can have the value \"join\", \"lucene\", \"edismax\", or \"geofilt\".\nFor more information about the query syntax and the available query parameters, see the Solr documentation.\n\n### ***Limitation of sort and pagination*** "
},
{
"info": {
"name": "Search in the delivery collection",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/mydelivery/v1/search",
"params": [
{
"name": "defType",
"value": "",
"type": "query",
"description": "The Solr \"defType\" parameter. Specify \"defType=edismax\" to use the edismax query parser."
},
{
"name": "df",
"value": "",
"type": "query",
"description": "Either the Solr \"df\" or \"qf\" parameter is required. The parameter is supported by the edismax query parser."
},
{
"name": "facet",
"value": "",
"type": "query",
"description": "The Solr \"facet\" parameter enables faceted search. Always set this parameter to true if you are using the other \"facet\" parameters."
},
{
"name": "facet.contains",
"value": "",
"type": "query",
"description": "The Solr \"facet.contains\" parameter returns only facets containing this term."
},
{
"name": "facet.containsIgnoreCase",
"value": "",
"type": "query",
"description": "The Solr \"facet.containsIgnoreCase\" parameter ignores case when the \"facet.contains\" parameter is applied."
},
{
"name": "facet.field",
"value": "",
"type": "query",
"description": "The Solr \"facet.field\" parameter identifies a field to be used as a facet."
},
{
"name": "facet.limit",
"value": "",
"type": "query",
"description": "The Solr \"facet.limit\" parameter specifies a limit for the number of results that are returned for each facet. Default value is 100."
},
{
"name": "facet.offset",
"value": "",
"type": "query",
"description": "The Solr \"facet.offset\" parameter specifies an offset into the facet results that are returned and can be used for paging facet results. Default value is 0."
},
{
"name": "facet.prefix",
"value": "",
"type": "query",
"description": "The Solr \"facet.prefix\" parameter returns only facets with this prefix."
},
{
"name": "facet.range",
"value": "",
"type": "query",
"description": "The Solr \"facet.range\" parameter."
},
{
"name": "facet.range.end",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.end\" parameter."
},
{
"name": "facet.range.gap",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.gap\" parameter."
},
{
"name": "facet.range.start",
"value": "",
"type": "query",
"description": "The Solr \"facet.range.start\" parameter."
},
{
"name": "fl",
"value": "",
"type": "query",
"description": "The Solr \"fl\" parameter defines the fields that are returned in the response. By default, the search service returns all fields that are highlighted in the \"Stored\" column of the table at the beginning of this document."
},
{
"name": "fq",
"value": "",
"type": "query",
"description": "The Solr \"fq\" parameter applies a filter query to the search results."
},
{
"name": "f..",
"value": "",
"type": "query",
"description": "Many \"facet\" parameters can be overridden on a per-field basis using the syntax \"f..=\". For example, to specify a general limit of 10 terms for all facet fields and a specific limit of 5 terms for only the \"category\" facet field, use \"facet.limit=10\" and \"f.category.facet.limit=5\"."
},
{
"name": "indent",
"value": "",
"type": "query",
"description": "If the Solr \"indent\" parameter is not \"off\" and has a non-blank value, then Solr attempts at indenting the XML response such that it is easier to read. The default behavior is not to indent the XML response."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "The Solr \"q\" parameter uses Solr/Lucene standard query syntax."
},
{
"name": "qf",
"value": "",
"type": "query",
"description": "Either the Solr \"df\" or \"qf\" parameter is required. The parameter is supported by the edismax query parser."
},
{
"name": "rows",
"value": "",
"type": "query",
"description": "The Solr \"rows\" parameter controls how many documents are returned at the most, and can be used for paging query results. The default value is 10. The maximum allowed value is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "The Solr \"sort\" parameter controls sorting of the query response. Sorting on not unique fields can cause paging to return duplicate or missing entries in subsequent pages of results. It's recommended to sort by unique field or a combination ex. sort=lastModied desc, status desc."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The Solr \"start\" parameter specifies an offset into the responses, which are returned and can be used for paging query results. Default value is 0."
}
]
},
"docs": "Performs a search query by passing all query parameters to Solr. \nSearch results will contain unprotected and protected items. This route is restricted to authenticated users.\nThe supported query parser for the \"defType\" parameter can be \"edismax\" or \"lucene\". The query parser name defined in \"q\" or \"fq\" parameter through \"{! ...}\" can have the value \"join\", \"lucene\", \"edismax\", or \"geofilt\". For more information about the query syntax and the available query parameters, see the Sol"
}
]
},
{
"info": {
"name": "Delivery sites",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get the site descriptor of a public site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/sites/:siteId",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site item, or `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `id` and `name` this parameter should look like `id,name`. Undefined fields are ignored."
}
]
},
"docs": "Returns the site descriptor of the site specified by *siteId*.\n
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Get the site descriptor of a public or protected site.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/mydelivery/v1/sites/:siteId",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site item, or `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `id` and `name` this parameter should look like `id,name`. Undefined fields are ignored."
}
]
},
"docs": "Returns the site descriptor of the site specified by *siteId*.\n
User roles: admin, manager, editor, viewer, authenticatedVisitor"
},
{
"info": {
"name": "Get the site descriptor of a public site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v2/sites/:siteId",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site item, or `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `id` and `name` this parameter should look like `id,name`. Undefined fields are ignored."
}
]
},
"docs": "Returns the site descriptor of the site specified by *siteId*.\n
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Get the site descriptor of a public or protected site.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/mydelivery/v2/sites/:siteId",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site item, or `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `id` and `name` this parameter should look like `id,name`. Undefined fields are ignored."
}
]
},
"docs": "Returns the site descriptor of the site specified by *siteId*.\n
User roles: admin, manager, editor, viewer, authenticatedVisitor"
},
{
"info": {
"name": "Get the descriptor of a public page from a site.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/sites/:siteId/pages/:pageId",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "pageId",
"value": "",
"type": "path",
"description": "The ID of the page item."
},
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site item, or `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `id` and `name` this parameter should look like `id,name`. Undefined fields are ignored."
}
]
},
"docs": "Returns the descriptor of the page item specified by *pageId*. The page is contained in a site that is contained in *siteId*\n
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Get the descriptor of a public or protected page from a site.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/mydelivery/v1/sites/:siteId/pages/:pageId",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "pageId",
"value": "",
"type": "path",
"description": "The ID of the page item."
},
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site item, or `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `id` and `name` this parameter should look like `id,name`. Undefined fields are ignored."
}
]
},
"docs": "Returns the descriptor of the page item specified by *pageId*. The page is contained in a site that is contained in *siteId*\n
User roles: admin, manager, editor, viewer, authenticatedVisitor"
},
{
"info": {
"name": "Get all public child pages of a specified parent page",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/delivery/v1/sites/:siteId/pages/by-parent/:parentPageId",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "parentPageId",
"value": "",
"type": "path",
"description": "The ID of the parent page item, or *@top* to retrieve the top-level pages."
},
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site item, or `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `id` and `name` this parameter should look like `id,name`. Undefined fields are ignored."
},
{
"name": "count",
"value": "",
"type": "query",
"description": "specifies the maximum number of items that should be returned in this request. If this parameter is not specified, up to 100 page items are returned."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "specifies the starting offset of the result set being returned. For example, if the value of this paramter is 5, the first 5 items in the result set are ignored. If this parameter is not specified, the starting offset of the result set is 0."
}
]
},
"docs": "Returns the descriptors of all public child pages which are direct children of the parent page that is specified by *parentPageId*. The page is a member of the site that is specified in *siteId*.\nIf the value of *parentPageId* is ***@top***, then the descriptors of the top-level pages are returned.\n
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Get all public or protected child pages of a specified parent page",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/mydelivery/v1/sites/:siteId/pages/by-parent/:parentPageId",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "parentPageId",
"value": "",
"type": "path",
"description": "The ID of the parent page item, or *top* to retrieve the top-level pages."
},
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site item, or `@current` to indicate that the ID of the site is derived from the addressed URL via custom domain site mapping or URL path based site addressing. For further details consult the Content documentation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Reduce the returned content down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `id` and `name` this parameter should look like `id,name`. Undefined fields are ignored."
},
{
"name": "count",
"value": "",
"type": "query",
"description": "specifies the maximum number of items that should be returned in this request. If this parameter is not specified, up to 100 page items are returned."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "specifies the starting offset of the result set being returned. For example, if the value of this paramter is 5, the first 5 items in the result set are ignored. If this parameter is not specified, the starting offset of the result set is 0."
}
]
},
"docs": "Returns the descriptors of all public or protected child pages which are direct children of the parent page that is specified by *parentPageId*. The page is a member of the site that is specified in *siteId*.\nIf the value of *parentPageId* is ***@top***, then the descriptors of the top-level pages are returned.\n
User roles: admin, manager, editor, viewer, authenticatedVisitor"
}
]
},
{
"info": {
"name": "Tenant Registry",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve a tenant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/registry/v1/currenttenant",
"headers": [
{
"name": "x-ibm-dx-tenant-id",
"value": ""
}
],
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "return these json fields ex ?fields=id,name"
}
]
},
"docs": "##### Example request using curl\n\n`curl -X GET {api-url}/registry/v1/currenttenant`\nIf the user is not logged in then the /definitions/TenantAnonymous is returned\n
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Update a tenant",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/registry/v1/currenttenant",
"headers": [
{
"name": "x-ibm-dx-tenant-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "##### Example request using curl\n\n`curl -X PUT -d '{\"_id\":\"85b4686b-8614-475f-8933-144d42f84521\",\"locale\":\"de\", \"name\":\"sample_tenant\"}' {api-url}/registry/v1/currenttenant`\n
User roles: admin"
}
]
},
{
"info": {
"name": "Login service",
"type": "folder"
},
"items": [
{
"info": {
"name": "Remove tenant and auth cookie.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/login/v1/removecookies"
},
"docs": "Endpoint to receive a set-cookie cleaning the authentication and tenant cookies for the actual domain.
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Userid and password login using GET operation",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/login/v1/basicauth",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "accept-privacy-notice",
"value": "",
"type": "query",
"description": "(Optional) To accept the latest privacy notice."
}
]
},
"docs": "Performs basic authentication using Acoustic ID credentials. The API responds with authentication token (set in the cookie) and tenant information in the response header x-ibm-dx-tenant-id/x-cms-tenant-id. If no tenant for the user is found, the authentication fails presenting a HTTP404 error.\nYou can also use API key generated by MyAcoustic page, in which case username is AcousticAPIKey while generating the Base64 encoded Authorization header.
User roles: admin, manager, editor, viewer, au"
},
{
"info": {
"name": "Userid and password login using POST operation",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/login/v1/basicauth",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "accept-privacy-notice",
"value": "",
"type": "query",
"description": "(Optional) To accept the latest privacy notice."
}
]
},
"docs": "Performs basic authentication using Acoustic ID credentials. The API responds with authentication token (set in the cookie) and tenant information in the response header x-ibm-dx-tenant-id/x-cms-tenant-id. If no tenant for the user is found, the authentication fails presenting a HTTP404 error.\nYou can also use API key generated by MyAcoustic page, in which case username is AcousticAPIKey while generating the Base64 encoded Authorization header.
User roles: admin, manager, editor, viewer, au"
}
]
},
{
"info": {
"name": "Administering user profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Find the current user",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/user-profile/v1/users/currentuser",
"headers": [
{
"name": "x-ibm-dx-user-auth",
"value": ""
}
]
},
"docs": "Returns the current user
User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous"
},
{
"info": {
"name": "Find all users.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/user-profile/v1/users",
"params": [
{
"name": "external-id",
"value": "",
"type": "query",
"description": "The unique external identifier of the user (e.g. BlueID)."
},
{
"name": "privacy-notice",
"value": "",
"type": "query",
"description": "Parameter which must be set if the users privacy notice should be returned"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The index of the first item to be included in the response"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to be included in the response"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Include additional information sections"
}
]
},
"docs": "Returns an array containing all users matching the query.
User roles: admin"
},
{
"info": {
"name": "Add a new user.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/user-profile/v1/users",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a new user and returns the user object.
User roles: admin"
},
{
"info": {
"name": "Find user by ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/user-profile/v1/users/:id",
"headers": [
{
"name": "x-ibm-dx-user-auth",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique internal identifier of the entity that should be processed"
},
{
"name": "privacy-notice",
"value": "",
"type": "query",
"description": "Parameter which must be set if the users privacy notice should be returned"
}
]
},
"docs": "Returns a single user.
User roles: admin"
},
{
"info": {
"name": "Update an existing user.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/user-profile/v1/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique internal identifier of the entity that should be processed"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing user and returns the updated user object.
User roles: admin"
},
{
"info": {
"name": "Delete an existing user.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/user-profile/v1/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique internal identifier of the entity that should be processed"
},
{
"name": "privacy-notice",
"value": "",
"type": "query",
"description": "Parameter which must be set if the users privacy notice should be returned"
}
]
},
"docs": "Deletes an existing user.
User roles: admin"
}
]
},
{
"info": {
"name": "Webhook profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieves the webhook profile for the current tenant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/webhook/v1/profile",
"headers": [
{
"name": "If-None-Match",
"value": ""
}
],
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Only the content type fields that are specified here are returned for each result. Any type document field is a valid value and can be specified as a comma-separated list."
}
]
},
"docs": "Use the /profile end-point to retrieve the webhook profile from the database.
User roles: admin"
},
{
"info": {
"name": "Creates or updates the webhook profile for the current tenant",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/webhook/v1/profile",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /profile end-point to save the webhook profile within the database. This will overwrite any existing webhook profile.\n### Sample Webhook Payload (sent to specified URLs)\n```\n{\n \"event\":\"created\"\n \"timestamp\": \"2018-09-03T01:48:15.921Z\"\n \"doc\" : {\n ...\n }\n}\n```\n
User roles: admin"
},
{
"info": {
"name": "Deletes the webhook profile for the current tenant.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/webhook/v1/profile"
},
"docs": "Use the /profile endpoint to delete the webhook profile from the database.
User roles: admin"
}
]
},
{
"info": {
"name": "Publishing",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/publishing/v1/jobs",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /jobs endpoint to create a job. The job starts automatically and runs asynchronously. Use the /jobs/current-job/status to retrieve the details about the current job status.
User roles: admin, manager"
},
{
"info": {
"name": "Retrieve an existing job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/publishing/v1/jobs/current-job"
},
"docs": "Use the /jobs/current-job endpoint to retrieve current-job from the database.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Retrieve the status of current-job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/publishing/v1/jobs/current-job/status"
},
"docs": "Use the /jobs/current-job/status endpoint to retrieve the status information for the current-job.
User roles: admin, manager, editor"
},
{
"info": {
"name": "Get the default site revision",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/publishing/v1/site-revisions/default",
"params": [
{
"name": "include",
"value": "",
"type": "query",
"description": "Optional include parameter. Currently the links section can be included using the value 'links'."
}
]
},
"docs": "Use the /site-revisions/default endpoint to retrieve the default site revision
User roles: admin, manager, editor"
},
{
"info": {
"name": "Update the default site revision",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/publishing/v1/site-revisions/default",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use the /site-revisions/default endpoint to update the values of properties 'autoPublishEnabled', 'name' and 'description' by replacing them with the ones in request body. Please note: Modifications to the 'autoPublishEnabled' flag are not picked up by WCH immediately but with a time lag of up to 30 seconds
User roles: admin, manager"
}
]
}
],
"bundled": true
}