{ "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Dynamic Content - Management APIs", "termsOfService": "https://amplience.com/terms-conditions", "contact": { "email": "support@amplience.com", "url": "https://docs.amplience.net" }, "description": "# Introduction\n\nThe Dynamic Content Management API helps you integrate your back end systems with Dynamic Content.\n\nThe API is designed for building back-office applications and you can use it for webhook integrations, content automation apps, or to integrate with your existing back end services.\n\nTo use the API, you'll need a client ID and secret. The authorization section below explains how to use the client ID and secret to obtain an access token that must be included with each request.\n\n# Authentication\n\n## oauth2\n\nDynamic Content uses [OAuth2](https://oauth.net/2/) to authorize access to the Dynamic Content management API.\n\nTo use the API you will need an API key and secret. These credentials will be provided to you by Amplience at the beginning of your project, or you can request them from Amplience support. Your API key will define the resources to which you have access.\n\nYour API key and secret are used to obtain an access token from the Amplience authorization service. This token must be included in the authorization header of all requests to the Dynamic Content management API and is set to expire after a set time period, generally 300 seconds.\n\n\n## Getting an access token\n\nTo get an authorization token, send a ```POST``` request to the Amplience authorization server at ```https://auth.amplience.net``` as follows.\n\n### Request\n\n```\nPOST https://auth.amplience.net/oauth/token\n```\n\n### Headers\n\n| Header | Description |\n| ------------- |-------------|\n|Content-Type |application/x-www-form-urlencoded\n\n\n### Parameters\n\nThe parameters should be URL encoded and included in the body of the request:\n```\nclient_id={yourclientid}&client_secret={yoursecret}&grant_type=client_credentials\n```\n\nReplace ```{yourclientid}``` and ```{yoursecret}``` with your client id and secret.\n\n| Parameter | Description |\n| ------------- |-------------|\n|client_id |The client id (API key) provided to you by Amplience |\n|client_secret|The client secret provided to you by Amplience |\n|grant_type|Set this to ```client_credentials``` to specify that the authorization token should be generated based on the client ID and secret |\n\n### Response\n\n#### Status codes\n\n| Status code | Description |\n| ------------- |-------------|\n|200|OK. Credentials are valid. |\n|400|Bad Request. client id or secret are not valid.|\n\n#### Response body\n\nIf the clientID and secret are valid, the response body will be returned as in the example below.\n\nNote that the example access_token has been truncated.\n\n```\n{\n \"access_token\": \"eyJraWQiOiJhbXBsaWVuY2UtdG9rZW4tc2lnbmluZy1rZXkiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJhbXBsaWVuY2UuY29tIiwiZXhwIjoxNTUzODY4NjIyLCJqdGkiOiJMT2pvZ1dtMFM3TkRNT2VsTk96cWVnIiwiaWF0IjoxNTUzODY3MzYyLCJzd…\",\n \"session_expires_in\": 0,\n \"expires_in\": 300\n}\n```\n\nYou will need to save the access token and include it in requests to the API. If the token has expired, request another token from the authorization service.\n\nThe [Dynamic Content management SDK](https://github.com/amplience/dc-management-sdk-js) contains code to help you manage the access token.\n\n\n## Including the token in an API request\n\nTo make a request to the Dynamic Content management API, for example to list all the hubs you have access to you would send a request such as:\n\n```\nGET https://api.amplience.net/v2/content/hubs\n```\n\nIn the request header you must set the Authorization format to \"Bearer\" and include the access token:\n\n```\nAuthorization : Bearer {access_token}\n```\n\nReplace {access_token} with the access token returned by the authorization service.\n\n\nIf the access token is valid, then the request is processed and the response is returned.\n\n\n# Usage\n\n## Routing\n\nResources can usually be retrieved using a `/resource-types/:id` endpoint.\nCollection resources will always be pluralised, regardless of how they are\naccessed. In cases where resources are nested under a parent resource, and this\ncontext is necessary for the request, this information is included in the\nrouting. For example, while a Content Repository can be retrieved by id using\n`GET /content-repositories/:id`, to create a new Content Repository it is\nnecessary to supply the ID of the parent Hub, so the route would take the form\n`POST /hubs/:hubId/content-repositories`.\n\n## HAL\n\nResources are returned in the HAL format, which provides a representation of\nHATEOAS information in JSON. This allows for discoverability of endpoints from\nresponses, as a response for a resource will contain links to related resources\nand actions. Links are contained within a `_links` object, and are keyed by\nname. In some cases, such as resource listing or search results, linked\nresources are included in the response inside an `_embedded` object, allowing\nmultiple resource to be returned within the same response body.\n\n## Status Codes\n\nResponse codes for the API are described in the table below.\n\n## Status Code Table\n\n| Status Code | Reason Phrase | Purpose |\n| ----------- |---------------| ------- |\n|200 | OK | Successful retrieval or update of a resource or list of resources |\n|201 | Created | Successful creation of a resource |\n|202 | Accepted | A background task has been initiated, but is still processing |\n|204 | No Content | Indicates the following:
* Success with deleting a resource
* Success with granting or revoking permissions
* Success with nothing to report |\n|400 | Bad Request | Non-specific error with request |\n|401 | Unauthorized | No valid token was supplied in the request, or the token could not be decoded |\n|403 | Forbidden | The user lacks either the required functional or ACL permissions to make this request |\n|404 | Not Found | The requested resource does not exist, or the user does not have access to it |\n|405 | Method Not Allowed | The requested HTTP method is not permitted for this resource type |\n|406 | Not Acceptable | The requested resource is not available in the format requested by the user agent |\n|409 | Conflict | The requested change conflicts with the current state of the resource |\n|415 | Unsupported Media Type | The format of the resource supplied by the user agent is not supported by the server |\n|500 | Internal Server Error | Non specific error occurred on the server |\n\n\n## Error Response Format\n\nIf an error occurs, the response body contains a JSON object containing an\nerrors array. This will contain one or more error objects, containing a message\nfield describing the error, and context specific metadata relating to this\ninstance of the error.\n\n```http\nHTTP/1.1 409 Conflict\nX-Content-Type-Options: nosniff\nX-XSS-Protection: 1; mode=block\nCache-Control: no-cache, no-store, max-age=0, must-revalidate\nPragma: no-cache\nExpires: 0\nStrict-Transport-Security: max-age=31536000 ; includeSubDomains\nX-Frame-Options: DENY\nContent-Type: application/hal+json;charset=UTF-8\nContent-Length: 145\n\n{\n \"errors\" : [ {\n \"entity\" : \"Hub\",\n \"property\" : \"name\",\n \"invalidValue\" : \"anya-finn\",\n \"message\" : \"name must be unique\"\n } ]\n}\n```\n\n\n## Guidance on using HTTP PATCH\n\nWhen updating a resource, the `PATCH` method is used. When making a `PATCH`\nrequest, any fields specified in the request will overwrite their associated\nvalues in the stored resource, but omitted fields will remain unchanged. This\nis in contrast to the `PUT` method, which would set omitted fields to null, and\nis not supported in this API. When making a `PATCH` request to a resource\ncontaining nested JSON objects, it is important to note that child objects are\nreplaced completely, and do not inherit the `PATCH` functionality of the root\nobject.\n\nFor example, given a stored resource in the format:\n\n```json\n{\n \"foo\": {\n \"bar\": \"abc\",\n \"baz\": \"xyz\"\n },\n \"bar\": \"123\"\n}\n```\n\nWhen the following request body is used in a `PATCH` request:\n\n```json\n{\n \"foo\": {\n \"bar\": \"def\"\n }\n}\n```\n\nThe resource would be transformed to the following:\n\n```json\n{\n \"foo\": {\n \"bar\": \"def\"\n },\n \"bar\": \"123\"\n}\n```\n\n### Payload Considerations\n\nWhen submitting a JSON payload to the API, the first **complete** JSON object in the body will be accepted, and any\nadditional information will be discarded. For example:\n\n```json\n{\n \"foo\": {\n \"bar\": \"def\"\n },\n \"unknownProperty\": \"will be ignored\"\n}\n```\n\nIn the above example, there is an extra closing brace and additional characters that follow a valid JSON object.\nAny extra input characters like this will be ignored by the API.\n" }, "externalDocs": { "description": "Amplience Documentation Hub", "url": "https://docs.amplience.net" }, "tags": [ { "name": "Administration", "description": "Administration allows you to add or revoke permissions for users and manage access to resources." }, { "name": "Content Items", "description": "## Text Search Query Syntax\nA simple query syntax is provided to allow full text search on content items. Several characters have special meaning and are reserved:\n\n_Table 2. Reserved Search Characters_\n\n| Description | Symbol |\n| ----------- | -------- |\n| Negation Operator \t| - \t|\n| Field Search Operator \t| : \t|\n| Quote (for exact search) \t| \" \t|\n| Comma (list multiple search terms) \t| , \t|\n\nPlease note that the text search is case insensitive, and will only display content items within the hub. See the following examples for an explanation of the query syntax:\n\n_Table 3. Text Search Examples_\n\n| Query | Meaning |\n| ----- | ------- |\n| apple \t| Find all content items containing the word \"apple\" \t|\n| apple orange \t| Find all content items containing the words \"apple\" AND \"orange\" \t|\n| apple,orange \t| Find all content items containing either \"apple\" OR \"orange\" \t|\n| apple -orange \t| Find all content items that contain the word \"apple\" but NOT \"orange\" \t|\n| -apple-orange \t| Find all content items that don’t contain \"apple-orange\" (hyphens in the middle of a word are not treated as negation) \t|\n| label:apple \t| Find all content items that contain the word \"apple\" within the \"label\" field \t|\n| \"apple:orange\" \t| Find all content items containing \"apple:orange\" (quotes must be used to search for a colon character) \t|\n| apple label:orange \t| Find all content items containing the word \"apple\" anywhere within them, AND the word \"orange\" in the label field \t|\n" }, { "name": "Content Repositories" }, { "name": "Content Types" }, { "name": "Editions" }, { "name": "Events" }, { "name": "Extensions" }, { "name": "Folders", "description": "Folders are used to organise items in a hierarchical structure. Currently only enabled for organising content items within a content repository." }, { "name": "Hubs", "description": "Hubs are containers for multiple repositories including media, content, content types." }, { "name": "Localization", "description": "There are 2 methods of localizing your content into multiple languages, field-level localization and item-level localization. With field-level localization, your content type schema defines which values in your content can be translated into different languages. All translations exist as data in a single item. With item-level localization, you create separate copies of your content for each language." }, { "name": "Integrations" }, { "name": "Localization" }, { "name": "Publishing Jobs" }, { "name": "Salesforce Commerce Cloud (SFCC)" }, { "name": "Salesforce Marketing Cloud (SFMC)" }, { "name": "Search Indexes", "description": "Dynamic Content search is powered by Algolia. Algolia search indexes can be created to index data for one or more assigned content types. Content can then be queried from your frontend using [Algolia's search APIs and SDKs](https://www.algolia.com/doc/guides/building-search-ui/getting-started/js/)." }, { "name": "Search Indexes - Analytics" }, { "name": "Slots", "description": "\"Slots\" are content-items which are stored in separate repositories from other content-items. Their role is to be placeholders for snapshots.\n\n## Example Slot Content Type\n\n```json\n{\n \"$schema\" : \"http://bigcontent.io/cms/schema/v1/schema#\",\n \"id\" : \"http://deliver.bigcontent.io/schema/simple-slot-type.json\",\n \"title\" : \"slot\",\n \"description\" : \"Slot Container\",\n \"type\":\"object\",\n \"properties\": {\n \"slot\": {\n \"title\": \"simple slot container\",\n \"allOf\":[\n {\"$ref\": \"http://bigcontent.io/cms/schema/v1/core#/definitions/content-link\" },\n {\n \"properties\": {\n \"contentType\": { \"enum\": [ \"http://deliver.bigcontent.io/schema/nested/nested-type.json\" ] }\n }\n }\n ]\n }\n }\n}\n```\nYou will need to register a content type capable of holding nested content in order to create a slot.\n\n## Pre-requsites\n\n### Creating a Slot Repository\nA Slot Repository is just a Content Repository with the \"slots\" feature. See [adding features to repositories](#operation/assignContentRepositoryFeature) for more information\n\n### Creating a Slot\nA Slot is a Content Item in a Slot Repository. Please refer to [creating a content item](#operation/createContentItem) for more information.\n\n## Associating Slots to Editions\n\nOnce you have a Slot Repository with some Slots you can then associate them with an Edition in order make them available for publishing.\n\n* Multiple Slots can be associated to an Edition, up to 200\n* A Slot can be associated with multiple Editions\n* A Slot can only be associated to an Edition once\n\nWhen you associate Slots to an Edition, the `slotsRemaining` property on the Edition will decrease. If you attempt to associate more Slots than there are remaining on the Edition, the operation will fail.\n\nPlease refer to the [Assign Edition Slots section](#operation/assignEditionSlots) for an example request.\n\n### Retrieving Slots associated to an Edition\nPlease refer to the [Retrieving Edition Slots section](#operation/getEditionSlots) for an example request.\n\n### Retrieving Slots associated to an Edition filter by content item\nTo filter by content item, we supply the `includedSlots` query parameter. Please refer to the [Get Edition Slots section](#operation/getEditionSlots) for an example request.\n\n### Retrieving an single Slot associated to an Edition\nPlease refer to the [Get Edition Slot section](#operation/getEditionSlot) for an example request.\n\n### Removing the association between a Slot and an Edition\nPlease refer to the [Delete Edition Slot section](#operation/deleteEditionSlot) for an example request.\n\n## Associating Snapshots to Slots\nA slot is a placeholder for one or more snapshots. In order to associate those snapshots to this slot you will need to post the resulting content-item to the slot url.\n\nNotice that in the below request, `body.slot.id` is the path to a snapshot. Not a content item.\n\nThe `body.slot.id` can also be set to null when the user hasn't currently assigned all of the fields. The service will accept this data, however the `valid` field will be set to false.\n\nPlease refer to the [Create Edition Slot Content section](#operation/putEditionSlotContent) for an example request.\n" }, { "name": "Snapshots", "description": "A Snapshot is an immutable representation of a content item with all of its descendants (including their versions) at a given point in time." }, { "name": "Webhooks" }, { "name": "Workflows", "description": "It is possible to define a list of workflow states on a hub which will allow users to implement one or more rudimentary workflows. Each content item within the hub can have its status set to one of the workflow states defined within the hub.\n\nIn the interest of flexibility, the transitions between states are not validated. In other words, it is possible to transition a content item from any state into any other state.\n\nFor more information on adding a workflow to a content item see [Assigning a workflow](#operation/assignContentItemWorkflowState)\n" } ], "servers": [ { "url": "https://api.amplience.net/v2/content" } ], "paths": { "/admin": { "get": { "tags": [ "Administration" ], "summary": "List Administrative Operations", "description": "Lists the available administrative operations.", "operationId": "listAdminOps", "responses": { "200": { "description": "List of HAL links to perform the desired operations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminResponse" } } } } } } }, "/admin/access": { "get": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS" ] } ], "summary": "Manage Access to Resources", "description": "With the ability to manage access you can control which users have which permissions to the resources you administer.", "operationId": "manageAccess", "responses": { "200": { "description": "List of HAL links to manage permissions of users for resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminAccessResponse" } } } } } } }, "/admin/access/{resource}/{resourceId}": { "get": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS" ] } ], "summary": "List Operations on a resource", "description": "Given the id of a resource for which you are an administrator, you can see the various operations that you can perform. Simply follow the appropriate link for the resource passing in the id.\n\n| Resource Type | Required Functional Permissions | Required ACLs |\n|-----------------------|----------------------------------------------------------------------------------------|--------------------------------------------------|\n| hubs | `CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS` `CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS` | `Hub - READ``Hub - MANAGE_ACCESS` |\n| content\\-repositories | `CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS` `CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS` | `Hub - READ` `ContentRepository - MANAGE_ACCESS` |\n", "operationId": "listOperations", "parameters": [ { "in": "path", "name": "resource", "schema": { "type": "string", "enum": [ "hubs", "content-repositories" ] }, "required": true, "description": "Resource Type", "example": "hubs" }, { "in": "path", "name": "resourceId", "schema": { "type": "string" }, "required": true, "description": "Resource ID", "example": "00112233445566778899aabb" } ], "responses": { "200": { "description": "List of resource Operations", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AdminOperationsListResponse" }, { "required": [ "_links" ] } ] }, "examples": { "Hubs": { "value": { "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/5d5bc260c9e77c035fee1c6e" }, "members": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/5d5bc260c9e77c035fee1c6e/members" }, "member": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/5d5bc260c9e77c035fee1c6emembers/{sid}" } } } }, "Content Repositories": { "value": { "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/5d5bc260c9e77c035fee1c6e" }, "members": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/5d5bc260c9e77c035fee1c6e/members" }, "member": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/5d5bc260c9e77c035fee1c6emembers/{sid}" } } } } } } } } } } }, "/admin/access/{resource}/{resourceId}/members": { "get": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS" ] } ], "summary": "List members on a resource", "description": "The memebrs link will list the memebrs that have access to a particular resource. This includes the member's id (sid) and the list of permissions they have.\n\n| Resource Type | Required Functional Permissions | Required ACLs |\n|-----------------------|----------------------------------------------------------------------------------------|--------------------------------------------------|\n| hubs | `CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS` `CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS` | `Hub - READ` `Hub - MANAGE_ACCESS` |\n| content\\-repositories | `CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS` `CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS` | `Hub - READ` `ContentRepository - MANAGE_ACCESS` |\n", "operationId": "listMembers", "parameters": [ { "in": "path", "name": "resource", "schema": { "type": "string", "enum": [ "hubs", "content-repositories" ] }, "required": true, "description": "Resource Type", "example": "hubs" }, { "in": "path", "name": "resourceId", "schema": { "type": "string" }, "required": true, "description": "Resource ID", "example": "00112233445566778899aabb" } ], "responses": { "200": { "description": "List of resource members", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminMembersListResponse" }, "examples": { "hub": { "summary": "Hub", "value": { "_embedded": { "members": [ { "sid": "alice", "permissions": [ "READ", "EDIT", "DELETE", "SHARE", "CREATE_REPOSITORY", "CREATE_EVENT", "EDIT_EVENT", "DELETE_EVENT", "CREATE_EDITION", "EDIT_EDITION", "DELETE_EDITION", "MANAGE_ACCESS", "EDIT_WORKFLOW_STATES" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/alice" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/alice/permissions/{permission}", "templated": true } } }, { "sid": "bob", "permissions": [ "READ" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/bob" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/bob/permissions/{permission}", "templated": true } } }, { "sid": "charlie", "permissions": [ "READ", "CREATE_REPOSITORY" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/charlie" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/charlie/permissions/{permission}", "templated": true } } }, { "sid": "david", "permissions": [ "READ" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/david" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/david/permissions/{permission}", "templated": true } } }, { "sid": "ewan", "permissions": [ "READ" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/ewan" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/ewan/permissions/{permission}", "templated": true } } } ] }, "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members" } } } }, "content-repository": { "summary": "Content Repository", "value": { "_embedded": { "members": [ { "sid": "alice", "permissions": [ "READ", "EDIT", "DELETE", "SHARE", "CREATE_CONTENT", "EDIT_CONTENT", "DELETE_CONTENT", "MANAGE_ACCESS" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/alice" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/alice/permissions/{permission}", "templated": true } } }, { "sid": "bob", "permissions": [ "READ" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/bob" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/bob/permissions/{permission}", "templated": true } } }, { "sid": "charlie", "permissions": [ "READ", "CREATE_CONTENT" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/charlie" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/charlie/permissions/{permission}", "templated": true } } }, { "sid": "david", "permissions": [ "READ" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/david" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/david/permissions/{permission}", "templated": true } } }, { "sid": "ewan", "permissions": [ "READ" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/ewan" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members/ewan/permissions/{permission}", "templated": true } } } ] }, "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/content-repositories/00112233445566778899aabb/members" } } } } } } } } } } }, "/admin/access/{resource}/{resourceId}/members/{sid}": { "get": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS" ] } ], "summary": "Get a member by id", "description": "Given a resource and a member id you can navigate directly to a specific member by following the \"member\" link from the resource.
\n\n| Resource Type | Required Functional Permissions | Required ACLs |\n|-----------------------|----------------------------------------------------------------------------------------|--------------------------------------------------|\n| hubs | `CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS` `CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS` | `Hub - READ` `Hub - MANAGE_ACCESS` |\n| content\\-repositories | `CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS` `CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS` | `Hub - READ` `ContentRepository - MANAGE_ACCESS` |\n", "operationId": "adminAccessGetMember", "parameters": [ { "in": "path", "name": "resource", "schema": { "type": "string", "enum": [ "hubs", "content-repositories" ] }, "required": true, "description": "Resource Type", "example": "hubs" }, { "in": "path", "name": "resourceId", "schema": { "type": "string" }, "required": true, "description": "Resource ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "sid", "schema": { "type": "string" }, "required": true, "description": "Member ID", "example": "alice" } ], "responses": { "200": { "description": "The requested member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" }, "examples": { "hub": { "summary": "Hub", "value": { "sid": "alice", "permissions": [ "READ" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/alice" }, "revoke-permission": { "href": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/alice/permissions/{permission}", "templated": true } } } } } } } } } } }, "/admin/access/{resource}/{resourceId}/members/{sid}/permissions/{permissions}": { "delete": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS" ] } ], "summary": "Revoking permissions", "description": "Revoke access to a specific resource by deleting a members permission.
From a member, follow the \"revoke-permission\" link passing in the permission to delete.
You can specify one or multiple permissions. Multiple permissions are comma separated.
Resource TypeRequired Functional PermissionsRequired ACLs
hubsCONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESSHub - READ
Hub - MANAGE_ACCESS
content-repositoriesCONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESSHub - READ
ContentRepository - MANAGE_ACCESS
", "operationId": "revokeMemberPermission", "parameters": [ { "in": "path", "name": "resource", "schema": { "type": "string", "enum": [ "hubs", "content-repositories" ] }, "required": true, "description": "Resource Type", "example": "hubs" }, { "in": "path", "name": "resourceId", "schema": { "type": "string" }, "required": true, "description": "Resource ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "sid", "schema": { "type": "string" }, "required": true, "description": "Member ID", "example": "alice" }, { "in": "path", "name": "permissions", "schema": { "type": "string" }, "required": true, "description": "Permission(s) to revoke (comma separated list)", "example": [ "READ", "EDIT" ] } ], "responses": { "204": { "description": "No Content" } } } }, "/admin/modules": { "get": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_MODULES" ] } ], "summary": "Manage Modules on Resources", "description": "Modules offer additional functionality which is not enabled by default. With the ability to manage modules you can control which modules are enabled on the resources you administer.\n", "operationId": "manageModules", "responses": { "200": { "description": "List of HAL links to manage modules on resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminModulesResponse" } } } } } } }, "/admin/modules/hubs/{hubId}": { "get": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT", "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_MODULES", "FN: CONTENT:FUNCTIONAL:HUB:EDIT" ] } ], "summary": "List Module Operations on a Hub", "description": "Given the id of a hub for which you are an administrator, you can see the various module management operations that you can perform. Simply follow the appropriate link for the resource passing in the id.\n", "operationId": "listHubModuleOperations", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "responses": { "200": { "description": "List of hub module management operations", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AdminOperationsListHubModulesResponse" }, { "required": [ "_links" ] } ] } } } } } } }, "/admin/modules/hubs/{hubId}/algolia-search": { "post": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT", "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_MODULES", "FN: CONTENT:FUNCTIONAL:HUB:EDIT" ] } ], "summary": "Enable the Search Index module on a hub", "description": "Enable the Search Indexes module (Algolia Search) on the specified hub. Simply follow the appropriate link for the resource passing in the id.\n", "operationId": "enableAlgoliaSearech", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "responses": { "200": { "description": "The updated hub with the module enabled", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubProperties" } } } } } } }, "/admin/modules/hubs/{hubId}/content-delivery-2": { "post": { "tags": [ "Administration" ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT", "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_MODULES", "FN: CONTENT:FUNCTIONAL:HUB:EDIT" ] } ], "summary": "Enable the Content Delivery 2 module on a hub", "description": "Enable the Content Delivery 2 module on the specified hub. Simply follow the appropriate link for the resource passing in the id.\n", "operationId": "enableCd2Module", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "responses": { "200": { "description": "The updated hub with the module enabled", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubProperties" } } } } } } }, "/algolia-search/{hubId}/indexes": { "get": { "tags": [ "Search Indexes" ], "summary": "List Indexes", "operationId": "getAlgoliaSearchIndexes", "description": "List Algolia search indexes for a given hub\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "parentId", "schema": { "type": "string" }, "required": false, "description": "Filter by the parentId. \n\nAn empty string will return all primary indexes.\n", "example": 20 }, { "in": "query", "name": "projection", "schema": { "type": "string", "enum": [ "withSettings" ] }, "required": false, "description": "Project addition values in list response\n\n* \"withSettings\" - includes the settings for each index\n" }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Set the number of results per page", "example": 20 }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort parameter", "example": "label,asc" }, { "in": "query", "name": "status", "schema": { "type": "string" }, "required": false, "description": "Comma seperated list of statuses", "example": "ACTIVE,ARCHIVED" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "List of Algolia Search indexes for the given hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexListResponseProperties" } } } } } }, "post": { "tags": [ "Search Indexes" ], "summary": "Create an Index", "operationId": "createAlgoliaSearchIndex", "description": "Create a new Algolia search index\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:CREATE" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndex" } } } }, "responses": { "201": { "description": "Algolia Search Index", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndex" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}": { "get": { "tags": [ "Search Indexes" ], "summary": "Get an Index", "operationId": "getAlgoliaSearchIndex", "description": "Get an Algolia search index for a given hub\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Get Algolia Search indexes for the given hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndex" } } } } } }, "patch": { "tags": [ "Search Indexes" ], "summary": "Update an Index", "operationId": "patchAlgoliaSearchIndex", "description": "Update an active Algolia search index.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexUpdate" } } } }, "responses": { "200": { "description": "Algolia Search Index Update Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndex" } } } } } }, "delete": { "tags": [ "Search Indexes" ], "summary": "Delete an Index", "operationId": "deleteAlgoliaSearchIndex", "description": "Delete an Algolia search index for a given hub\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:DELETE" ] } ], "responses": { "204": { "description": "Delete Algolia Search index for the given hub" } } } }, "/algolia-search/{hubId}/indexes/{indexId}/analytics/no-results-rate": { "get": { "tags": [ "Search Indexes - Analytics" ], "summary": "Get rate of no results for an index", "operationId": "getAlgoliaSearchIndexAnalyticsGetNoResultsRate", "description": "Returns the rate at which searches did not return any results. A value is returned for the whole range. Values per days are also returned. Additionally, the search count and the count of searches without results, used to compute the rates, are returned as well.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "startDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC", "example": "2020-07-16" }, { "in": "query", "name": "endDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC", "example": "2020-07-23" }, { "in": "query", "name": "tags", "schema": { "type": "string" }, "required": false, "description": "Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g:\n\n* “lang:fr OR lang:en”\n* “platform:ios AND lang:en”\n* “(lang:fr OR lang:en) AND platform:android”\n* “device:mobile%20phone” (note the URL encoded)\n", "example": "platform:ios" }, { "in": "query", "name": "includeReplicas", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Include replica data in the results (Can only be used in conjunction with primary indexes).", "example": true } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Rate of no results for a given index", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAnalyticsRateOfNoResults" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/analytics/searches-count": { "get": { "tags": [ "Search Indexes - Analytics" ], "summary": "Get count of searches for an index", "operationId": "getAlgoliaSearchIndexAnalyticsGetSearchCount", "description": "Returns the number of searches across the given time range. A value is returned for the whole range. Additionally, values for each day are returned.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "startDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC", "example": "2020-07-16" }, { "in": "query", "name": "endDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC", "example": "2020-07-23" }, { "in": "query", "name": "tags", "schema": { "type": "string" }, "required": false, "description": "Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g:\n\n* “lang:fr OR lang:en”\n* “platform:ios AND lang:en”\n* “(lang:fr OR lang:en) AND platform:android”\n* “device:mobile%20phone” (note the URL encoded)\n", "example": "platform:ios" }, { "in": "query", "name": "includeReplicas", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Include replica data in the results (Can only be used in conjunction with primary indexes).", "example": true } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Count of searches for a given index", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAnalyticsSearchesCount" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/analytics/searches-with-no-results": { "get": { "tags": [ "Search Indexes - Analytics" ], "summary": "Get top searches with no results", "operationId": "getAlgoliaSearchIndexAnalyticsGetSearchesWithNoResults", "description": "Returns top searches that did not return any results. Limited to the 1000 most frequent.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "startDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC", "example": "2020-07-16" }, { "in": "query", "name": "endDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC", "example": "2020-07-23" }, { "in": "query", "name": "limit", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "How many items to fetch.", "example": 10 }, { "in": "query", "name": "offset", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "From which position to start retrieving results.", "example": "0" }, { "in": "query", "name": "tags", "schema": { "type": "string" }, "required": false, "description": "Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g:\n\n* “lang:fr OR lang:en”\n* “platform:ios AND lang:en”\n* “(lang:fr OR lang:en) AND platform:android”\n* “device:mobile%20phone” (note the URL encoded)\n", "example": "platform:ios" }, { "in": "query", "name": "includeReplicas", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Include replica data in the results (Can only be used in conjunction with primary indexes).", "example": true } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Top searches that did not return any results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAnalyticsListSearchesWithNoResults" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/analytics/top-filters-no-result-search": { "get": { "tags": [ "Search Indexes - Analytics" ], "summary": "Get top filters no result search", "operationId": "getAlgoliaSearchIndexAnalyticsGetTopFiltersNoResultSearch", "description": "Returns top filters that did not return any results for given search. Limited to the top 1000.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "search", "schema": { "type": "string" }, "required": true, "description": "The query term. Must match the exact user input", "example": "q0" }, { "in": "query", "name": "startDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC", "example": "2020-07-16" }, { "in": "query", "name": "endDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC", "example": "2020-07-23" }, { "in": "query", "name": "limit", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "How many items to fetch.", "example": 10 }, { "in": "query", "name": "offset", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "From which position to start retrieving results.", "example": "0" }, { "in": "query", "name": "tags", "schema": { "type": "string" }, "required": false, "description": "Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g:\n\n* “lang:fr OR lang:en”\n* “platform:ios AND lang:en”\n* “(lang:fr OR lang:en) AND platform:android”\n* “device:mobile%20phone” (note the URL encoded)\n", "example": "platform:ios" }, { "in": "query", "name": "includeReplicas", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Include replica data in the results (Can only be used in conjunction with primary indexes).", "example": true } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Top searches that did not return any results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAnalyticsListTopFiltersNoResultSearch" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/analytics/top-hits": { "get": { "tags": [ "Search Indexes - Analytics" ], "summary": "Get top hits for an index", "operationId": "getAlgoliaSearchIndexAnalyticsGetTopHits", "description": "If `search` is supplied, the top hits for the given search.\n\nIf `search` is omitted, the overall top hits will be returned for this index.\n\nLimited to the 1000 most frequent ones.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "Get top hits for a given search. Must match the exact user input.", "example": "term" }, { "in": "query", "name": "startDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC", "example": "2020-07-16" }, { "in": "query", "name": "endDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC", "example": "2020-07-23" }, { "in": "query", "name": "limit", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "How many items to fetch.", "example": 10 }, { "in": "query", "name": "offset", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "From which position to start retrieving results.", "example": "0" }, { "in": "query", "name": "tags", "schema": { "type": "string" }, "required": false, "description": "Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g:\n\n* “lang:fr OR lang:en”\n* “platform:ios AND lang:en”\n* “(lang:fr OR lang:en) AND platform:android”\n* “device:mobile%20phone” (note the URL encoded)\n", "example": "platform:ios" }, { "in": "query", "name": "includeReplicas", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Include replica data in the results (Can only be used in conjunction with primary indexes).", "example": true } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Top hits for a given search term", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAnalyticsListTopHits" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/analytics/top-searches": { "get": { "tags": [ "Search Indexes - Analytics" ], "summary": "Get top searches for an index", "operationId": "getAlgoliaSearchIndexAnalyticsGetTopSearches", "description": "Returns top searches. Limited to the 1000 most frequent ones. For each search, also returns the average number of hits returned.\n\nIf `clickAnalytics=true`, then for each search, also returns:\n\n* the click through rate,\n* the conversion rate,\n* the average click position.\n\nYou can also order the results using `orderBy` and `direction`.\n\nDistinguishing _no data_ vs 0% CTR, 0% CR, no average\n\n* You have click analytics enabled but no queries were received with clickAnalytics=true\n * in that case CTR, CR and average will be `null`.\n* You have click analytics enabled, we received queries with clickAnalytics=true\n* CTR and CR are 0 until we receive click/conversion events\n* average will stay null until we receive a click event\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "clickAnalytics", "schema": { "type": "boolean", "default": false }, "required": false, "description": "If `true`, then for each search, also returns:\n\n* the click through rate,\n* the conversion rate,\n* the average click position.\n", "example": false }, { "in": "query", "name": "orderBy", "schema": { "type": "string" }, "required": false, "description": "You can reorder the results by passing one of the following:\n\n* searchCount\n* clickThroughRate\n* conversionRate\n* averageClickPosition\n", "example": null }, { "in": "query", "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false, "description": "Change the order of the results", "example": "desc" }, { "in": "query", "name": "startDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC", "example": "2020-07-16" }, { "in": "query", "name": "endDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC", "example": "2020-07-23" }, { "in": "query", "name": "limit", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "How many items to fetch.", "example": 10 }, { "in": "query", "name": "offset", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "From which position to start retrieving results.", "example": "0" }, { "in": "query", "name": "tags", "schema": { "type": "string" }, "required": false, "description": "Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g:\n\n* “lang:fr OR lang:en”\n* “platform:ios AND lang:en”\n* “(lang:fr OR lang:en) AND platform:android”\n* “device:mobile%20phone” (note the URL encoded)\n", "example": "platform:ios" }, { "in": "query", "name": "includeReplicas", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Include replica data in the results (Can only be used in conjunction with primary indexes).", "example": true } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Top searches for a given index", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAnalyticsListTopSearches" }, "examples": { "clickAnalyticsFalse": { "summary": "clickAnalytics=false", "value": { "_embedded": { "searches": [ { "search": "q0", "count": 3, "nbHits": 10 }, { "search": "q1", "count": 3, "nbHits": 10 } ] }, "_links": { "self": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=20" }, "searches": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches{?clickAnalytics,orderBy,direction,startDate,endDate,limit,offset,tags}", "templated": true }, "first": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=0" }, "next": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=30" }, "prev": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=10" } } } }, "clickAnalyticsTrue": { "summary": "clickAnalytics=true", "value": { "_embedded": { "searches": [ { "search": "q0", "count": 3, "nbHits": 10, "clickThroughRate": 3, "averageClickPosition": 1, "conversionRate": 0.5, "trackedSearchCount": 2, "clickCount": 2, "conversionCount": 1 }, { "search": "q1", "count": 3, "nbHits": 10, "clickThroughRate": 3, "averageClickPosition": 1, "conversionRate": 0.5, "trackedSearchCount": 2, "clickCount": 2, "conversionCount": 1 } ] }, "_links": { "self": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=20" }, "searches": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches{?clickAnalytics,orderBy,direction,startDate,endDate,limit,offset,tags}", "templated": true }, "first": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=0" }, "next": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=30" }, "prev": { "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=10" } } } } } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/analytics/user-count": { "get": { "tags": [ "Search Indexes - Analytics" ], "summary": "Get count of users", "operationId": "getAlgoliaSearchIndexAnalyticsUserCount", "description": "Returns count of distinct user across the given time range.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "startDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC", "example": "2020-07-16" }, { "in": "query", "name": "endDate", "schema": { "type": "string", "format": "date" }, "required": false, "description": "The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC", "example": "2020-07-23" }, { "in": "query", "name": "includeReplicas", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Include replica data in the results (Can only be used in conjunction with primary indexes).", "example": true }, { "in": "query", "name": "tags", "schema": { "type": "string" }, "required": false, "description": "Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g:\n\n* “lang:fr OR lang:en”\n* “platform:ios AND lang:en”\n* “(lang:fr OR lang:en) AND platform:android”\n* “device:mobile%20phone” (note the URL encoded)\n", "example": "platform:ios" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Count of distinct user across the given time range", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexUserCount" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/archive": { "post": { "tags": [ "Search Indexes" ], "summary": "Archive an Algolia Search Index", "operationId": "archiveAlgoliaSearchIndex", "description": "Archive an Algolia Search Index\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:DELETE" ] } ], "responses": { "200": { "description": "Archived Algolia Search Index", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AlgoliaSearchIndex" }, { "type": "object", "properties": { "status": { "example": "ARCHIVED" } } } ] } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/assigned-content-types": { "get": { "tags": [ "Search Indexes" ], "summary": "List Assigned Content Types", "operationId": "listAlgoliaSearchIndexAssignedContentTypes", "description": "List all content types assigned to a search index. Each content type should have an associated webhook, which updates the index with content item data.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Set the number of results per page", "example": 20 }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort parameter", "example": "createdDate,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Algolia Search Index", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAssignedContentTypeListResponse" } } } } } }, "post": { "tags": [ "Search Indexes" ], "summary": "Create an Assigned Content Type", "operationId": "assignAlgoliaSearchIndexAssignedContentType", "description": "Assign content type to a search index. Assigning a content type will create an associated webhook, which updates the index with content item data.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:CREATE", "FN: CONTENT:FUNCTIONAL:WEBHOOK:CREATE" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAssignedContentType" } } } }, "responses": { "201": { "description": "Algolia Search Index", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAssignedContentType" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/assigned-content-types/{contentTypeId}": { "get": { "tags": [ "Search Indexes" ], "summary": "Get Assigned Content Type", "operationId": "getAlgoliaSearchIndexAssignedContentType", "description": "Get an assigned content type for a search index. A content type should have an associated webhook, which updates the index with content item data.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "contentTypeId", "schema": { "type": "string" }, "required": true, "description": "Assigned Content Type ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Algolia Search Index", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexAssignedContentType" } } } } } }, "delete": { "tags": [ "Search Indexes" ], "summary": "Delete an Assigned Content Type", "operationId": "deleteAlgoliaSearchIndexAssignedContentType", "description": "Delete an assigned content type for a search index.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "contentTypeId", "schema": { "type": "string" }, "required": true, "description": "Assigned Content Type ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:DELETE", "FN: CONTENT:FUNCTIONAL:WEBHOOK:DELETE" ] } ], "responses": { "204": { "description": "Successfully deleted an assigned content type for a search index." } } } }, "/algolia-search/{hubId}/indexes/{indexId}/assigned-content-types/{contentTypeId}/recreate-webhook": { "post": { "tags": [ "Search Indexes" ], "summary": "Recreate Assigned Content Type Webhook", "operationId": "recreateAlgoliaSearchIndexAssignedContentTypeWebhook", "description": "Recreate the webhook for this assigned content type\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "contentTypeId", "schema": { "type": "string" }, "required": true, "description": "Assigned Content Type ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "active", "archived" ] }, "required": true, "description": "Type of webhook to create", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ", "FN: CONTENT:FUNCTIONAL:WEBHOOK:CREATE" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "204": { "description": "Successfully recreated the webhook" } } } }, "/algolia-search/{hubId}/indexes/{indexId}/clear": { "post": { "tags": [ "Search Indexes" ], "summary": "Clear an Index", "operationId": "postAlgoliaSearchIndexClear", "description": "Remove all objects from an Algolia search index\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "204": { "description": "Successfully cleared the Algolia search index" } } } }, "/algolia-search/{hubId}/indexes/{indexId}/keys/{keyId}": { "get": { "tags": [ "Search Indexes" ], "summary": "Get an API key", "operationId": "getAlgoliaSearchAPIKey", "description": "Get Algolia search API key for a given index/hub\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "keyId", "schema": { "type": "string" }, "required": true, "description": "Key ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Get search key by id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexApiKey" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/objects/{objectId}": { "delete": { "tags": [ "Search Indexes" ], "summary": "Delete an Index Object", "operationId": "deleteAlgoliaSearchIndexObject", "description": "Delete an object from a search index\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "objectId", "schema": { "type": "string" }, "required": true, "description": "Object ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:DELETE" ] } ], "responses": { "204": { "description": "Successfully deleted an object from a search index" } } } }, "/algolia-search/{hubId}/indexes/{indexId}/settings": { "get": { "tags": [ "Search Indexes" ], "summary": "Get Search Index Settings", "operationId": "getAlgoliaSearchIndexSettings", "description": "Get Algolia search index settings\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Algolia Search index settings for the given hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexSettingsProperties" } } } } } }, "patch": { "tags": [ "Search Indexes" ], "summary": "Update Search Index Settings", "operationId": "patchAlgoliaSearchIndexSettings", "description": "Update settings on an active Algolia search index.\n\nFor a complete list of index settings visit the [Algolia settings documentation](https://www.algolia.com/doc/api-reference/settings-api-parameters).\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "forwardToReplicas", "schema": { "type": "boolean" }, "description": "Forward to replicas", "example": true } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexSettingsProperties" } } } }, "responses": { "204": { "description": "Successfully updated Algolia search index settings" } } } }, "/algolia-search/{hubId}/indexes/{indexId}/stats": { "get": { "tags": [ "Search Indexes" ], "summary": "Get Search Index Statistics", "operationId": "getAlgoliaSearchIndexStats", "description": "Get Algolia search index statistics\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:READ" ] } ], "responses": { "200": { "description": "Algolia Search index statistics for the given hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgoliaSearchIndexStatisticsProperties" } } } } } } }, "/algolia-search/{hubId}/indexes/{indexId}/unarchive": { "post": { "tags": [ "Search Indexes" ], "summary": "Unarchive an Algolia Search Index", "operationId": "unarchiveAlgoliaSearchIndex", "description": "Unarchive an Algolia Search Index\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "indexId", "schema": { "type": "string" }, "required": true, "description": "Index ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ALGOLIA_SEARCH:DELETE" ] } ], "responses": { "200": { "description": "Unarchived Algolia Search Index", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AlgoliaSearchIndex" }, { "type": "object", "properties": { "status": { "example": "ACTIVE" } } } ] } } } } } } }, "/content-items": { "patch": { "tags": [ "Content Items" ], "summary": "Update Multiple Content Items", "description": "Update Multiple Content Items\n", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT", "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT" ] } ], "requestBody": { "description": "Update Multiple Content Items", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMultipleContentItems" } } } }, "responses": { "207": { "description": "Update Multiple Content Items response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMultipleContentItemsResponse" } } } } } } }, "/content-items/{contentItemId}": { "get": { "tags": [ "Content Items" ], "summary": "Get Content Item", "operationId": "getContentItem", "description": "Get a Content Item\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemRequiredProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] } } } } } }, "patch": { "tags": [ "Content Items" ], "summary": "Update Content Item", "operationId": "updateContentItem", "description": "Update a Content Item. Please note that deliveryKey can only be set when [Content Delivery 2](https://docs.amplience.net/api/dynamic-content/delivery/content-delivery-2/) is enabled.\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "requestBody": { "description": "Updated Content Item\n\nSupports one or multiple Content Items\n", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemWithAssigneesProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] } } } }, "responses": { "200": { "description": "Updated Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] } } } } } } }, "/content-items/{contentItemId}/archive": { "post": { "tags": [ "Content Items" ], "summary": "Archive Content Item", "operationId": "archiveContentItem", "description": "Archive a Content Item\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - DELETE_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:DELETE" ] } ], "requestBody": { "description": "Version to archive", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "version" ], "properties": { "version": { "type": "integer", "description": "Version to archive", "example": 1 } } } } } }, "responses": { "200": { "description": "Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemRequiredProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" }, { "type": "object", "properties": { "status": { "example": "ARCHIVED" } } } ] } } } } } } }, "/content-items/{contentItemId}/associations": { "get": { "tags": [ "Content Items" ], "summary": "Get Content Item Associations", "operationId": "getContentItemAssociations", "description": "Get Content Item Associations\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Get Content Item Associations response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemAssociationsResponse" }, "example": { "contentItemId": "00112233-4455-6677-8899-aabbccddeeff", "associations": [ { "eventTitle": "Test", "eventId": "00112233445566778899aabb", "eventStart": "2019-01-01T00:00:00.000Z", "eventEnd": "2019-01-01T00:00:00.000Z", "editionTitle": "Test", "editionId": "00112233445566778899aabb", "editionStart": "2019-01-01T00:00:00.000Z", "editionEnd": "2019-01-01T00:00:00.000Z", "editionPubStatus": "DRAFT", "editionSlotTitle": "Simple Slot", "editionSlotId": "00112233445566778899aabb", "editionSlotLocked": true, "editionSlotLastModifiedDate": "2019-01-01T00:00:00.000Z", "editionContentTitle": null, "editionContentId": null, "editionContentLocked": null, "editionContentLastModifiedDate": null, "editionContentMultiRoot": false, "snapshotComments": "This is an example snapshot.", "snapshotCreatedBy": "user", "snapshotCreatedDate": "2019-01-01T00:00:00.000Z", "snapshotId": "00112233445566778899aabb", "usageCount": 1, "snapshotLocale": "en-GB", "contentTypeSchema": "http://deliver.bigcontent.io/schema/simple-slot-type.json", "_links": { "get-content": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb" }, "update-content": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}", "templated": true } } }, { "eventTitle": "Test", "eventId": "00112233445566778899aabb", "eventStart": "2019-01-01T00:00:00.000Z", "eventEnd": "2019-01-01T00:00:00.000Z", "editionTitle": "Test", "editionId": "00112233445566778899aabb", "editionStart": "2019-01-01T00:00:00.000Z", "editionEnd": "2019-01-01T00:00:00.000Z", "editionPubStatus": "DRAFT", "editionSlotTitle": null, "editionSlotId": null, "editionSlotLocked": null, "editionSlotLastModifiedDate": null, "editionContentTitle": "Banner Ad Homepage", "editionContentId": "00112233445566778899aabb", "editionContentLocked": true, "editionContentLastModifiedDate": "2019-01-01T00:00:00.000Z", "editionContentMultiRoot": true, "snapshotComments": "This is an example snapshot.", "snapshotCreatedBy": "user", "snapshotCreatedDate": "2019-01-01T00:00:00.000Z", "snapshotId": "00112233445566778899aabb", "usageCount": 1, "snapshotLocale": "en-GB", "contentTypeSchema": null, "_links": { "get-editionContent": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb" }, "update-editionContent": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}", "templated": true } } } ], "_links": { "edition-slot-associations": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/edition-slot-associations" }, "content-item-associations": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/associations" } } } } } } } } }, "/content-items/{contentItemId}/delivery-key": { "patch": { "tags": [ "Content Items" ], "summary": "Assigning a Delivery Key", "operationId": "assignContentItemDeliveryKey", "description": "Assign a delivery key to a content item or slot and replace any existing key. The delivery key must meet the validation rules and be unique within the hub.\n\n The current version of the content item must be included in the request payload. If the version specified is not the current one, then a 400 error will be returned in the response.", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "requestBody": { "description": "Assign Content Item Delivery Key request", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "deliveryKey", "version" ], "properties": { "deliveryKey": { "$ref": "#/components/schemas/DeliveryKey" }, "version": { "$ref": "#/components/schemas/Version" } } } } } }, "responses": { "200": { "description": "Assign Content Item Delivery Key response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] } } } } } } }, "/content-items/{contentItemId}/history": { "get": { "tags": [ "Content Items" ], "summary": "List Content Item History", "operationId": "listContentItemHistory", "description": "List Content Item History\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "List Content Item History response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContentItemHistoryResponse" } } } } } } }, "/content-items/{contentItemId}/locale": { "post": { "tags": [ "Localization" ], "summary": "Assigning locales to Content Items", "operationId": "assignContentItemLocales", "description": "Assign a locale to a Content Item\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "requestBody": { "description": "Assign Content Item Locale request", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "locale", "version" ], "properties": { "locale": { "description": "Locale", "type": "string", "example": "en-GB" }, "version": { "description": "Version", "type": "number", "minimum": 1, "example": 1 } } } } } }, "responses": { "200": { "description": "Assign Content Item Locale response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemProperties" } } } } } } }, "/content-items/{contentItemId}/localizations": { "get": { "tags": [ "Localization" ], "summary": "Listing the Localizations of a Content Item", "operationId": "listLocalizationsOfContentItem", "description": "Once a Content Item has been localized into one or more desired locales, you will be able to see the list of all localizations by following the \"localizations\" HAL link.\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Content Item response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemLocalizationListing" } } } } } } }, "/content-items/{contentItemId}/localize": { "post": { "tags": [ "Content Items" ], "summary": "Localize Content Item", "operationId": "localizeContentItem", "description": "Localize a Content Item\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - CREATE_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemLocalizeRequest" } ] } } } }, "responses": { "202": { "description": "Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemLocalizeResponse" } ] } } } } } } }, "/content-items/{contentItemId}/planned": { "get": { "tags": [ "Content Items" ], "summary": "Finding Content by Epoch", "operationId": "findingContentByEpoch", "description": "Find content items that are candidates for being published at a point in time.\n", "parameters": [ { "in": "query", "name": "epoch", "schema": { "type": "number" }, "description": "Epoch Time", "example": 1546300800 }, { "in": "query", "name": "time", "schema": { "type": "number" }, "description": "Time", "example": "2019-01-01T00:00:00.000Z" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Finding Content by Epoch response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindingContentByResponse" } } } } } } }, "/content-items/{contentItemId}/publish": { "post": { "tags": [ "Content Items" ], "summary": "Publish Content Item", "operationId": "publishContentItem", "description": "Publish a Content Item\n\nThe response `Location` header is the a URL of the created [Publishing Job](#operation/getPublishingJob)\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - PUBLISH_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } } } } } }, "/content-items/{contentItemId}/restore": { "put": { "tags": [ "Content Items" ], "summary": "Restore Content by Content Version Number", "operationId": "restoreContentByContentVersionNumber", "description": "Restore Content by Content Version Number\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT", "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT" ] } ], "requestBody": { "description": "Restore Content by Content Version Number request body", "content": { "application/json": { "schema": { "type": "object", "required": [ "version", "restoreVersion" ], "properties": { "version": { "type": "number", "description": "Version", "example": 2 }, "restoreVersion": { "type": "number", "description": "Restore Version", "example": 1 } } } } } }, "responses": { "200": { "description": "List Content Item Versions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreContentByVersionResponse" } } } } } } }, "/content-items/{contentItemId}/unarchive": { "post": { "tags": [ "Content Items" ], "summary": "Unarchive Content Item", "operationId": "unarchiveContentItem", "description": "Unarchive a Content Item\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "requestBody": { "description": "Version to unarchive", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "version" ], "properties": { "version": { "type": "integer", "description": "Version to unarchive", "example": 1 } } } } } }, "responses": { "200": { "description": "Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemRequiredProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" }, { "type": "object", "properties": { "status": { "example": "ACTIVE" } } } ] } } } } } } }, "/content-items/{contentItemId}/unpublish": { "post": { "tags": [ "Content Items" ], "summary": "Unpublish Content Item", "operationId": "unpublishContentItem", "description": "Unpublish a Content Item\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - PUBLISH_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "202": { "description": "Accepted" } } } }, "/content-items/{contentItemId}/versions": { "get": { "tags": [ "Content Items" ], "summary": "List Content Item Versions", "operationId": "listContentItemVersions", "description": "List Content Item Versions\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "List Content Item Versions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContentItemVersions" } } } } } } }, "/content-items/{contentItemId}/versions/{version}": { "get": { "tags": [ "Content Items" ], "summary": "Finding Content by Content Version Number", "operationId": "findingContentByContentVersionNumber", "description": "Finding Content by Content Version Number\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" }, { "in": "query", "name": "version", "schema": { "type": "number" }, "description": "Version", "example": 1 } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "List Content Item Versions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindingContentByResponse" } } } } } } }, "/content-items/{contentItemId}/versions/{version}/history": { "get": { "tags": [ "Content Items" ], "summary": "List Content Item History for a Version", "operationId": "listContentItemHistoryForAVersion", "description": "List Content Item History for a Version\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" }, { "$ref": "#/components/parameters/versionPath" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "List Content Item History for a Version response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContentItemHistoryVersion" } } } } } } }, "/content-items/{contentItemId}/workflow": { "patch": { "tags": [ "Content Items", "Workflows" ], "summary": "Assigning a Workflow State", "operationId": "assignContentItemWorkflowState", "description": "Assigning a Workflow State to a Content Item\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "requestBody": { "description": "Version to unarchive", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "version", "state" ], "properties": { "version": { "type": "integer", "description": "Version to unarchive", "example": 1 }, "state": { "type": "string", "description": "Workflow State ID", "example": "00112233445566778899aabb" } } } } } }, "responses": { "200": { "description": "Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] } } } } } } }, "/content-items/search/findByIdWithChildren": { "get": { "tags": [ "Content Items" ], "summary": "Getting Linked Child Content Items", "operationId": "gettingLinkedChildContentItems", "description": "Get Linked Child Content Items\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdQuery" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Get Linked Child Content Items response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GettingLinkedChildContentItemsResponse" } } } } } } }, "/content-items/search/findByIdWithParents": { "get": { "tags": [ "Content Items" ], "summary": "Getting Linked Parent Content Items", "operationId": "gettingLinkedParentContentItems", "description": "Get Linked Parent Content Items\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdQuery" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Get Linked Parent Content Items response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GettingLinkedParentContentItemsResponse" } } } } } } }, "/content-repositories/{contentRepositoryId}": { "get": { "tags": [ "Content Repositories" ], "summary": "Get Content Repository", "operationId": "getContentRepository", "description": "Get a new Content Repository\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:REPOSITORY:READ" ] } ], "responses": { "200": { "description": "Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } } } }, "patch": { "tags": [ "Content Repositories" ], "summary": "Update Content Repository", "operationId": "updateContentRepository", "description": "Update the Content Repository\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:REPOSITORY:EDIT" ] } ], "requestBody": { "description": "Updated Content Repository", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } }, "responses": { "200": { "description": "Updated Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } } } } }, "/content-repositories/{contentRepositoryId}/content-items": { "get": { "tags": [ "Content Repositories", "Content Items" ], "summary": "List Content Items", "operationId": "listContentRepositoryContentItems", "description": "This lists all of the Content Items within this Content Repository\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "projection", "description": "\"basic\" - omits the body property from the return Content Items\n", "schema": { "type": "string", "enum": [ "projection" ] }, "example": "basic" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "folderId", "schema": { "type": "string" }, "required": false, "description": "Folder ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "status", "schema": { "type": "string" }, "required": false, "description": "Status" }, { "in": "query", "name": "excludeHierarchicalChildren", "schema": { "type": "boolean" }, "required": false, "description": "Exclude hierarchical child items", "example": true }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "createdDate,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemListResponse" } } } } } }, "post": { "tags": [ "Content Items" ], "summary": "Create Content Item", "operationId": "createContentItem", "description": "Create a Content Item. Please note that deliveryKey can only be set when [Content Delivery 2](https://docs.amplience.net/api/dynamic-content/delivery/content-delivery-2/) is enabled. Copying a content item will not copy the deliveryKey.\n", "parameters": [ { "$ref": "#/components/parameters/contentRepositoryIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - CREATE_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "requestBody": { "description": "Content Item", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemRequiredProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] }, "examples": { "Create Content Item": { "$ref": "#/components/examples/ContentItem" }, "Slot Content Item": { "$ref": "#/components/examples/SlotContentItem" } } } } }, "responses": { "201": { "description": "Created Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] }, "examples": { "Create Content Item": { "$ref": "#/components/examples/ContentItemResponse" } } } } } } } }, "/content-repositories/{contentRepositoryId}/content-items/{sourceContentItemId}": { "post": { "tags": [ "Content Items" ], "summary": "Copy Content Item", "operationId": "copyContentItem", "description": "Copy a Content Item. Please note that deliveryKey can only be set when [Content Delivery 2](https://docs.amplience.net/api/dynamic-content/delivery/content-delivery-2/) is enabled. Copying a content item will not copy the deliveryKey.\n", "parameters": [ { "$ref": "#/components/parameters/contentRepositoryIdPath" }, { "in": "path", "name": "sourceContentItemId", "required": true, "schema": { "type": "string" }, "description": "Source Content Item ID (used to copy an existing Content Item)", "example": "00112233-4455-6677-8899-aabbccddeeff" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - CREATE_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "requestBody": { "description": "Content Item", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemRequiredProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] }, "examples": { "Copy Content Item": { "$ref": "#/components/examples/CopyContentItem" } } } } }, "responses": { "201": { "description": "Created Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] }, "examples": { "Copy Content Item": { "$ref": "#/components/examples/CopyContentItemResponse" } } } } } } } }, "/content-repositories/{contentRepositoryId}/content-types": { "post": { "tags": [ "Content Repositories", "Content Types" ], "summary": "Assign Content Type to Content Repository", "operationId": "assignContentTypeToContentRepository", "description": "Assign Content Type to a Content Repository\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:REPOSITORY:EDIT" ] } ], "requestBody": { "description": "Content Type ID to assign to the Content Reposiroty", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "contentTypeId" ], "properties": { "contentTypeId": { "type": "string", "description": "Content Type ID", "example": "00112233445566778899aabb" } } } } } }, "responses": { "201": { "description": "Updated Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } } } } }, "/content-repositories/{contentRepositoryId}/content-types/{contentTypeId}": { "delete": { "tags": [ "Content Repositories", "Content Types" ], "summary": "Remove Content Type from Content Repository", "operationId": "removeContentTypeToContentRepository", "description": "Remove a Content Type from a Content Repository\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "contentTypeId", "schema": { "type": "string" }, "required": true, "description": "Content Type ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:REPOSITORY:EDIT" ] } ], "responses": { "200": { "description": "Updated Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } } } } }, "/content-repositories/{contentRepositoryId}/features": { "post": { "tags": [ "Content Repositories" ], "summary": "Assign a feature", "operationId": "assignContentRepositoryFeature", "description": "Assign a feature to a Content Repository\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "feature", "schema": { "type": "string" }, "required": true, "description": "Feature", "example": "slots" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:REPOSITORY:EDIT" ] } ], "responses": { "204": { "description": "No Content Response" } } }, "delete": { "tags": [ "Content Repositories" ], "summary": "Remove a feature", "operationId": "removeContentRepositoryFeature", "description": "Remove a feature from a Content Repository\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "feature", "schema": { "type": "string" }, "required": true, "description": "Feature", "example": "slots" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:REPOSITORY:EDIT" ] } ], "responses": { "204": { "description": "No Content Response" } } } }, "/content-repositories/{contentRepositoryId}/folders": { "post": { "tags": [ "Folders" ], "summary": "Create Folder", "operationId": "createContentRepositoryfolder", "description": "Folders are used to organise items in a hierarchical structure. Currently only enabled for organising content items within a content repository.\n\nTo create a new folder follow the \"create-folder\" link from a content repository.\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:FOLDER:CREATE" ] } ], "requestBody": { "description": "Content Repository Folder", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FolderProperties" }, { "$ref": "#/components/schemas/FolderRequiredProperties" } ] } } } }, "responses": { "201": { "description": "Created Content Repository Folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderProperties" } } } } } }, "get": { "tags": [ "Folders" ], "summary": "List Folders", "operationId": "listContentRepositoryfolder", "description": "List all of the top-level Folders for a Content Repository\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "createdDate,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:FOLDER:READ" ] } ], "responses": { "200": { "description": "Top-level Folders", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderListResponse" } } } } } } }, "/content-repositories/{contentRepositoryId}/item-locales": { "patch": { "tags": [ "Localization" ], "summary": "Assigning locales to Content Repository", "operationId": "assignContentRepositoryLocales", "description": "In order to organise your localized content into separate repositories you can assign a set locales to a Content Repository. You may want to do this in order to give different teams different permissions to create or edit content based on locale.\n\nAssigning locales to a Content Repository has 2 effects. Firstly, you will only be able to assign locales to Content Items which match those assigned to the repository. Secondly, when localizing a content graph, the newly created Content Items will be created in the appropriate Content Repository which match the desired locale.\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:REPOSITORY:EDIT" ] } ], "requestBody": { "description": "Updating item locales request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemLocales" } } } }, "responses": { "200": { "description": "Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } } } } }, "/content-repositories/{contentRepositoryId}/localization-group": { "post": { "tags": [ "Localization" ], "summary": "Updating a Content Repository localization group", "operationId": "updateContentRepositoryLocalizationGroup", "description": "The following API allows you to make 2 or more Content Repositories part of the same \"group\". The new repository will leave it’s current group and join the group of the target repository. To do this, follow the \"join-localization-group\" HAL link from the target repository and specify the new repository in the body.\n\nFor example, lets say you have 3 Content Repositories, Repo1 has no locales assigned, Repo2 and Repo3 are both members of the same group and are assigned locales [\"en-GB\", \"en-US\"] and [\"fr-FR\"] respectively. The following example shows localizing en-GB content into fr-FR. A1 signifies that item A exists in Repo1.\n```\n A1 A1 A'1\n / \\ / \\ / \\\n B2 C1 ==> B2 C1 B'3 C'1\n / / \\ / / \\ / / \\\nD2 E2 F2 D2 E2 F2 D'3 E'3 F'3\n```\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:REPOSITORY:EDIT" ] } ], "requestBody": { "description": "Updating item locales request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalizationGroup" } } } }, "responses": { "200": { "description": "Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } } } } }, "/content-repositories/{contentRepositoryId}/localization-group/locales": { "get": { "tags": [ "Localization" ], "summary": "Get Content Repository localization group locales", "operationId": "getContentRepositoryLocalizationGroupLocales", "description": "List of all supported item locales in a Content Repository localization group.\nThis request can be made using the ID of any repository in the localization group.\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:REPOSITORY:READ" ] } ], "responses": { "200": { "description": "Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalizationGroupLocales" } } } } } } }, "/content-repositories/{contentRepositoryId}/share": { "post": { "tags": [ "Content Repositories" ], "summary": "Share a Content Repository", "operationId": "shareContentRepository", "description": "Share a Content Repository with another user\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - SHARE" ] } ], "requestBody": { "description": "Share request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Share" } } } }, "responses": { "204": { "description": "No Content Response" } } } }, "/content-types/{contentTypeId}": { "get": { "tags": [ "Content Types" ], "summary": "Get Content Type", "operationId": "getContentType", "description": "Get the request Content Type\n", "parameters": [ { "in": "path", "name": "contentTypeId", "schema": { "type": "string" }, "required": true, "description": "Content Type ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_TYPE:READ" ] } ], "responses": { "200": { "description": "Content Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeProperties" } } } } } }, "patch": { "tags": [ "Content Types" ], "summary": "Update Content Type", "operationId": "updateContentType", "description": "Update the Content Type\n", "parameters": [ { "in": "path", "name": "contentTypeId", "schema": { "type": "string" }, "required": true, "description": "Content Type ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT" ] } ], "requestBody": { "description": "Updated Content Type", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeProperties" } } } }, "responses": { "200": { "description": "Updated Content Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeProperties" } } } } } } }, "/content-types/{contentTypeId}/archive": { "post": { "tags": [ "Content Types" ], "summary": "Archive Content Type", "operationId": "archiveContentType", "description": "Archive a Content Type\n", "parameters": [ { "in": "path", "name": "contentTypeId", "schema": { "type": "string" }, "required": true, "description": "Content Type ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_TYPE:DELETE" ] } ], "responses": { "200": { "description": "Archived Content Type", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentTypeProperties" }, { "type": "object", "properties": { "status": { "example": "ARCHIVED" } } } ] } } } } } } }, "/content-types/{contentTypeId}/unarchive": { "post": { "tags": [ "Content Types" ], "summary": "Unarchive Content Type", "operationId": "unarchiveContentType", "description": "Unarchive a Content Type\n", "parameters": [ { "in": "path", "name": "contentTypeId", "schema": { "type": "string" }, "required": true, "description": "Content Type ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT" ] } ], "responses": { "200": { "description": "Unarchived Content Type", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentTypeProperties" }, { "type": "object", "properties": { "status": { "example": "ACTIVE" } } } ] } } } } } } }, "/editions/{editionId}": { "get": { "tags": [ "Editions" ], "summary": "Get Edition", "description": "Get Edition", "operationId": "getEdition", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "responses": { "200": { "description": "Get Edition response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditionProperties" }, { "$ref": "#/components/schemas/EditionRequiredProperties" } ] } } } } } }, "patch": { "tags": [ "Editions" ], "summary": "Update Edition", "description": "Update Edition", "operationId": "updateEdition", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:EDIT", "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EVENT", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionProperties" } } } }, "responses": { "200": { "description": "Update Edition response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionProperties" } } } } } }, "delete": { "tags": [ "Editions" ], "summary": "Delete Edition", "description": "Delete Edition", "operationId": "deleteEdition", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:EDIT", "FN: CONTENT:FUNCTIONAL:EDITION:DELETE", "ACL: Hub - READ", "ACL: Hub - EDIT_EVENT", "ACL: Hub - DELETE_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "responses": { "204": { "description": "Delete Edition response" } } } }, "/editions/{editionId}/archive": { "post": { "tags": [ "Editions" ], "summary": "Archive Edition", "operationId": "archiveEdition", "description": "Archiving an edition is irreversible, you cannot unarchive.\n", "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:EDIT", "FN: CONTENT:FUNCTIONAL:EDITION:DELETE", "ACL: Hub - READ", "ACL: Hub - EDIT_EVENT", "ACL: Hub - DELETE_EDITION" ] } ], "responses": { "200": { "description": "Archive Edition response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionPropertiesArchive" } } } } } } }, "/editions/{editionId}/conflicts": { "get": { "tags": [ "Editions" ], "summary": "Get Edition Conflicts", "description": "Get Edition Conflicts", "operationId": "getEditionConflicts", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "responses": { "200": { "description": "Get Edition Conflicts response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionConflictsResponse" } } } } } }, "put": { "tags": [ "Editions" ], "summary": "Resolve Edition Conflicts", "description": "Resolve Edition Conflicts", "operationId": "resolveEditionConflicts", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:EDIT", "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveEditionConflicts" } } } }, "responses": { "200": { "description": "Resolve Edition Conflicts response" } } } }, "/editions/{editionId}/conflicts/findByIdAndVersion": { "get": { "tags": [ "Editions" ], "summary": "Get Edition Conflict by Id and Version", "description": "Get Edition Conflict by Id and Version", "operationId": "getEditionConflictByIdAndVersion", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "$ref": "#/components/parameters/versionQuery" }, { "$ref": "#/components/parameters/idQuery" } ], "responses": { "200": { "description": "Edition Conflict by Id and Version response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionConflictByIdAndVersionResponse" } } } } } } }, "/editions/{editionId}/edition-contents": { "post": { "tags": [ "Editions" ], "summary": "Create Edition Content", "description": "Create Edition Content", "operationId": "createEditionContent", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "responses": { "200": { "description": "Create Edition Content Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionContentCreateResponse" }, "examples": { "Create Edition Content": { "$ref": "#/components/examples/EditionContentCreateResponse" } } } } } } }, "get": { "tags": [ "Editions" ], "summary": "List Edition Contents", "description": "List Edition Contents", "operationId": "listEditionContents", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "page to retrieve", "example": 1 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "description": "page size to retrieve", "example": 20 } ], "responses": { "200": { "description": "List Edition Content Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionContentListResponse" } } } } } } }, "/editions/{editionId}/edition-contents/{editionContentsId}": { "get": { "tags": [ "Editions" ], "summary": "Get Edition Content", "description": "Get Edition Content", "operationId": "getEditionContent", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "$ref": "#/components/parameters/editionContentIdPath" } ], "responses": { "200": { "description": "Edition Content Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionContentResponse" } } } } } }, "delete": { "tags": [ "Editions" ], "summary": "Delete Edition Content", "description": "Delete Edition Content", "operationId": "deleteEditionContent", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "$ref": "#/components/parameters/editionContentIdPath" } ], "responses": { "204": { "description": "No Content" } } } }, "/editions/{editionId}/edition-contents/{editionContentsId}/content": { "patch": { "tags": [ "Editions" ], "summary": "Associate Edition Content", "description": "Associate Snapshot to Edition Content", "operationId": "associateEditionContent", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "$ref": "#/components/parameters/editionContentIdPath" } ], "requestBody": { "description": "Associating Snapshots to Edition Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionContentContent" } } } }, "responses": { "200": { "description": "Associate Edition Content Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionContentAssociateResponse" }, "examples": { "Associate Edition Content": { "$ref": "#/components/examples/EditionContentAssociateResponse" } } } } } } } }, "/editions/{editionId}/preview": { "post": { "tags": [ "Editions" ], "summary": "Create Edition Preview", "description": "If an Edition has been Previewed or is Scheduled then you can retrieve the Snapshot to be used with the Preview application or in Time Machine.\n", "operationId": "createEditionPreview", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lastModifiedDate": { "description": "Last Modified Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z" }, "type": { "description": "Type", "type": "string", "example": "QUICKPREVIEW" } } } } } }, "responses": { "200": { "description": "Paginated Edition List response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionPreviewResponse" } } } } } }, "get": { "tags": [ "Editions" ], "summary": "Get Edition Preview", "description": "If an Edition has been Previewed or is Scheduled then you can retrieve the Snapshot to be used with the Preview application or in Time Machine.\n", "operationId": "getEditionPreview", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "responses": { "200": { "description": "Paginated Edition List response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionPreviewResponse" } } } } } }, "delete": { "tags": [ "Editions" ], "summary": "Delete Edition Preview", "description": "If an Edition has been Previewed it can be deleted, if the Edition is Scheduled then it cannot be deleted.\n", "operationId": "deleteEditionPreview", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "responses": { "204": { "description": "Delete Edition Preview response" } } } }, "/editions/{editionId}/schedule": { "post": { "tags": [ "Editions" ], "summary": "Schedule Edition", "description": "In order to schedule an Edition, the Edition must be in the DRAFT state, all Edition Slots must be in the 'VALID' state if there are any, the Edition must have at least one Slot or Content Snapshot, and there must be no conflicts in the Edition. This will then trigger the publishing job to take place on the start date of the Edition.\n", "operationId": "scheduleEdition", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:SCHEDULE", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lastModifiedDate": { "description": "Last Modified Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z" } } } } } }, "responses": { "204": { "description": "Schedule Edition response" } } }, "delete": { "tags": [ "Editions" ], "summary": "Unschedule Edition", "description": "If the Edition has been scheduled it is possible to cancel the publishing job by unscheduling the edition.\n", "operationId": "unscheduleEdition", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:SCHEDULE", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "responses": { "204": { "description": "Unschedule Edition response" } } } }, "/editions/{editionId}/slot-collisions": { "get": { "tags": [ "Editions" ], "summary": "Get Edition Slot Collisions", "description": "Get Edition Slot Collisions", "operationId": "getEditionSlotCollisions", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" } ], "responses": { "200": { "description": "Get Edition Slot Collisions response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionSlotCollisionsResponse" } } } } } } }, "/editions/{editionId}/slots": { "post": { "tags": [ "Editions" ], "summary": "Assign Edition Slots", "description": "Assign Edition Slots", "operationId": "assignEditionSlots", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "in": "query", "name": "sourceEditionSlotId", "schema": { "type": "string" }, "description": "Source Edition Slot ID used to copy Edition Slot to Edition", "example": "00112233445566778899aabb" } ], "requestBody": { "description": "Associate Slots to Editions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionSlots" } } } }, "responses": { "200": { "description": "Edition Slot Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionSlotListResponse" }, "examples": { "Associate Slots to Edition": { "$ref": "#/components/examples/EditionSlotListResponse" }, "Copy Edition Slot to Edition": { "$ref": "#/components/examples/EditionSlotResponse" } } } } } } }, "get": { "tags": [ "Editions" ], "summary": "Get Edition Slots", "description": "Get Edition Slots", "operationId": "getEditionSlots", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "page to retrieve", "example": 1 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "description": "page size to retrieve", "example": 20 }, { "in": "query", "name": "includedSlots", "schema": { "type": "string" }, "description": "Retrieving Slots associated to an Edition filtered by content item", "example": "00112233-4455-6677-8899-aabbccddeeff" } ], "responses": { "200": { "description": "Edition Slot Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionSlotListResponse" } } } } } } }, "/editions/{editionId}/slots/{slotId}": { "get": { "tags": [ "Editions" ], "summary": "Get Edition Slot", "description": "Get Edition Slot", "operationId": "getEditionSlot", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "$ref": "#/components/parameters/slotIdPath" } ], "responses": { "200": { "description": "Edition Slot Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionSlotResponse" } } } } } }, "delete": { "tags": [ "Editions" ], "summary": "Delete Edition Slot", "description": "Delete Edition Slot", "operationId": "deleteEditionSlot", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "$ref": "#/components/parameters/slotIdPath" } ], "responses": { "204": { "description": "No Content" } } } }, "/editions/{editionId}/slots/{slotId}/content": { "put": { "tags": [ "Editions" ], "summary": "Create Edition Slot Content", "description": "Create Edition Slot Content", "operationId": "putEditionSlotContent", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EDITION:EDIT", "ACL: Hub - READ", "ACL: Hub - EDIT_EDITION" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "$ref": "#/components/parameters/slotIdPath" } ], "requestBody": { "description": "Associating Snapshots to Slots", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionSlotContent" } } } }, "responses": { "200": { "description": "Edition Slot Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditionSlotResponse" }, { "type": "object", "properties": { "content": { "$ref": "#/components/schemas/EditionSlotContent" } } } ] } } } } } } }, "/editions/{editionId}/slots/{slotId}/preview": { "post": { "tags": [ "Editions" ], "summary": "Create Edition Slot Preview", "description": "Allows for creating a preview snapshot of an edition slot, without creating a full edition preview.\n", "operationId": "createEditionSlotPreview", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "$ref": "#/components/parameters/editionSlotIdPath" } ], "responses": { "200": { "description": "Snapshot ID response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionSlotPreviewResponse" } } } } } } }, "/editions/search/findByDate": { "get": { "tags": [ "Editions" ], "summary": "Find By Date Range", "description": "Find Editions using a Date Range", "operationId": "findByDate", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "in": "query", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "rangeStart", "schema": { "type": "string", "format": "date-time" }, "description": "The start date to search from", "example": "2019-01-01T00:00:00.000Z" }, { "in": "query", "name": "rangeEnd", "schema": { "type": "string", "format": "date-time" }, "required": false, "description": "The end date to search to", "example": "2019-01-01T00:00:00.000Z" }, { "in": "query", "name": "projection", "schema": { "type": "string", "enum": [ "withEvent" ] }, "required": false, "description": "Include child Editions" }, { "in": "query", "name": "bounded", "schema": { "type": "integer" }, "required": false, "description": "Find editions that have either started or ended within the date range. This parameter is ignored if `expiringIn` is set to true.", "example": 1 }, { "in": "query", "name": "publishingStatus", "schema": { "type": "string", "enum": [ "DRAFT", "SCHEDULING", "SCHEDULED", "PUBLISHED", "UNSCHEDULING", "PUBLISHING" ] }, "required": false, "description": "Publishing Status", "example": "DRAFT" }, { "in": "query", "name": "expiringIn", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Find editions that will end within the date range. When this is true, `bounded` is ignored.", "example": true }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Set the number of results per page", "example": 10 }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort parameter", "example": "createdDate,asc" } ], "responses": { "200": { "description": "Paginated Edition List response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionsListResponse" }, "examples": { "Paginated Editions List": { "$ref": "#/components/examples/EditionsFindByDateResponse" }, "With Event Projection": { "$ref": "#/components/examples/EditionFindByDateWithEventResponse" } } } } } } } }, "/editions/search/findByEvent": { "get": { "tags": [ "Editions" ], "summary": "Find By Event", "description": "Find Event by Id", "operationId": "findByEvent", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/eventIdQuery" } ], "responses": { "200": { "description": "Paginated Edition List response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionsListResponse" } } } } } } }, "/events/{eventId}": { "get": { "tags": [ "Events" ], "summary": "Get an Event", "operationId": "getEvent", "description": "Get an Event by ID\n", "parameters": [ { "in": "path", "name": "eventId", "schema": { "type": "string" }, "required": true, "description": "Event ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "projection", "schema": { "type": "string", "enum": [ "withEditions" ] }, "required": false, "description": "Include related Editions" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "The requested Event, including corresponding Editions if `projection=withEditions` was supplied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventProperties" }, "examples": { "Single Event": { "$ref": "#/components/examples/EventResponse" }, "With Edition Projection": { "$ref": "#/components/examples/EventWithEditionsResponse" } } } } } } }, "delete": { "tags": [ "Events" ], "summary": "Delete an Event", "operationId": "deleteEvent", "description": "Delete an Event by ID\n", "parameters": [ { "in": "path", "name": "eventId", "schema": { "type": "string" }, "required": true, "description": "Event ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:DELETE", "ACL: Hub - READ", "ACL: Hub - DELETE_EVENT" ] } ], "responses": { "204": { "description": "No Content" } } }, "patch": { "tags": [ "Events" ], "summary": "Update an Event", "operationId": "updateEvent", "description": "Update an Event by ID\n", "parameters": [ { "in": "path", "name": "eventId", "schema": { "type": "string" }, "required": true, "description": "Event ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:EDIT", "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventProperties" } } }, "required": true }, "responses": { "200": { "description": "The requested Event", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventProperties" } } } } } } }, "/events/{eventId}/archive": { "post": { "tags": [ "Events" ], "summary": "Archive Events", "operationId": "archiveEvents", "description": "Archiving an event is irreversible, you cannot unarchive. Archiving an event will also archive all editions contained within the event.\n", "parameters": [ { "in": "path", "name": "eventId", "schema": { "type": "string" }, "required": true, "description": "Event ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:DELETE", "ACL: Hub - READ", "ACL: Hub - DELETE_EVENT" ] } ], "responses": { "200": { "description": "Archived Event", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPropertiesArchive" } } } } } } }, "/events/{eventId}/editions": { "post": { "tags": [ "Editions" ], "summary": "Create Edition", "operationId": "createEdition", "parameters": [ { "$ref": "#/components/parameters/editionIdPath" }, { "in": "query", "name": "sourceEditionId", "schema": { "type": "string" }, "required": false, "description": "Duplicate an Edition by providing an Edition Id", "example": "00112233445566778899aabb" }, { "in": "query", "name": "projection", "schema": { "type": "string", "enum": [ "withEvent" ] }, "required": false, "description": "Include parent event for edition" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:EDIT", "FN: CONTENT:FUNCTIONAL:EDITION:CREATE", "ACL: Hub - READ", "ACL: Hub - EDIT_EVENT", "ACL: Hub - CREATE_EDITION" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditionProperties" }, { "$ref": "#/components/schemas/EditionRequiredProperties" } ] } } } }, "responses": { "200": { "description": "Create Edition response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditionProperties" }, { "$ref": "#/components/schemas/EditionRequiredProperties" } ] } } } } } }, "get": { "tags": [ "Editions" ], "summary": "List Editions", "operationId": "listEditions", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Edition List response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionsListResponse" } } } } } } }, "/events/{eventid}/editions/search": { "get": { "tags": [ "Editions" ], "summary": "Search Editions", "operationId": "searchEditions", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "parameters": [ { "$ref": "#/components/parameters/eventIdPath" } ], "responses": { "200": { "description": "Search Editions response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchEditionsResponse" } } } } } } }, "/events/search/findByDateRange": { "get": { "tags": [ "Events" ], "summary": "Search Events by date", "operationId": "searchEventsByDate", "description": "List all of the Events for a given date\n", "parameters": [ { "in": "query", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "rangeStart", "schema": { "type": "string", "format": "date-time" }, "required": true, "description": "The start date to search from", "example": "2019-01-01T00:00:00.000Z" }, { "in": "query", "name": "rangeEnd", "schema": { "type": "string", "format": "date-time" }, "required": false, "description": "The end date to search to", "example": "2019-01-01T00:00:00.000Z" }, { "in": "query", "name": "projection", "schema": { "type": "string", "enum": [ "withEditions" ] }, "required": false, "description": "Include child Editions" }, { "in": "query", "name": "bounded", "schema": { "type": "integer" }, "required": false, "description": "Find events that have either started or ended within the date range", "example": 1 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Set the number of results per page", "example": 10 } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Event List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventListResponse" }, "examples": { "Paginated Event List": { "$ref": "#/components/examples/EventListResponse" }, "With Editions Projection": { "$ref": "#/components/examples/EventListWithEditionsResponse" } } } } } } } }, "/events/search/findByDateRangeAndSlots": { "get": { "tags": [ "Events" ], "summary": "Search Events by date range and Slots", "operationId": "searchEventsByDateAndSlots", "description": "List all of the Events for a given date range and slot ID\n", "parameters": [ { "in": "query", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "rangeStart", "schema": { "type": "string", "format": "date-time" }, "required": true, "description": "The start date to search from", "example": "2019-01-01T00:00:00.000Z" }, { "in": "query", "name": "rangeEnd", "schema": { "type": "string", "format": "date-time" }, "required": false, "description": "The end date to search to", "example": "2019-01-01T00:00:00.000Z" }, { "in": "query", "name": "projection", "schema": { "type": "string", "enum": [ "withEditions" ] }, "required": false, "description": "Include child Editions" }, { "in": "query", "name": "bounded", "schema": { "type": "integer" }, "required": false, "description": "Find events that have either started or ended within the date range", "example": 1 }, { "in": "query", "name": "slots", "schema": { "type": "string" }, "required": true, "description": "Slot ID", "example": "00112233-4455-6677-8899-aabbccddeeff" }, { "in": "query", "name": "locales", "schema": { "type": "string" }, "required": false, "description": "Locale to match", "example": "en-GB" }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Set the number of results per page", "example": 10 } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Event List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventListResponse" }, "examples": { "Paginated Event List": { "$ref": "#/components/examples/EventListResponse" }, "With Editions Projection": { "$ref": "#/components/examples/EventListWithEditionsResponse" } } } } } } } }, "/extensions/{id}": { "get": { "tags": [ "Extensions" ], "summary": "Get Extension", "operationId": "getExtension", "description": "Return the extension with the specified ID.\n", "parameters": [ { "in": "path", "name": "extensionId", "schema": { "type": "string" }, "required": true, "description": "Extension ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:UI_EXTENSION:READ" ] } ], "responses": { "200": { "description": "Extension Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } } } }, "patch": { "tags": [ "Extensions" ], "summary": "Patch Extension", "operationId": "patchExtension", "description": "Patch an Extension", "parameters": [ { "in": "path", "name": "extensionId", "schema": { "type": "string" }, "required": true, "description": "Extension ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:UI_EXTENSION:EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } }, "required": true }, "responses": { "200": { "description": "Extension Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } } } }, "delete": { "tags": [ "Extensions" ], "summary": "Delete Extension", "operationId": "deleteExtension", "description": "Delete an Extension", "parameters": [ { "in": "path", "name": "extensionId", "schema": { "type": "string" }, "required": true, "description": "Extension ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:UI_EXTENSION:DELETE" ] } ], "responses": { "204": { "description": "Successfully removed the Extension" } } } }, "/folders/{folderId}": { "patch": { "tags": [ "Folders" ], "summary": "Create Folder", "operationId": "updateFolder", "description": "Update a folder\n", "parameters": [ { "in": "path", "name": "folderId", "schema": { "type": "string" }, "required": true, "description": "Folder ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:FOLDER:EDIT" ] } ], "requestBody": { "description": "Updated Folder", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderProperties" } } } }, "responses": { "200": { "description": "Updated Folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderProperties" } } } } } }, "get": { "tags": [ "Folders" ], "summary": "Get Folder", "operationId": "getFolder", "description": "Get a folder\n", "parameters": [ { "in": "path", "name": "folderId", "schema": { "type": "string" }, "required": true, "description": "Folder ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:FOLDER:READ" ] } ], "responses": { "200": { "description": "Folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderProperties" } } } } } }, "delete": { "tags": [ "Folders" ], "summary": "Delete Folder", "operationId": "deleteFolder", "description": "Delete a folder\n", "parameters": [ { "in": "path", "name": "folderId", "schema": { "type": "string" }, "required": true, "description": "Folder ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:FOLDER:DELETE" ] } ], "responses": { "204": { "description": "Success" } } } }, "/folders/{folderId}/folders": { "post": { "tags": [ "Folders" ], "summary": "Create Sub-Folder", "operationId": "createSubFolder", "description": "Create a new sub-folder.\n", "parameters": [ { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT", "FN: CONTENT:FUNCTIONAL:FOLDER:CREATE" ] } ], "requestBody": { "description": "Folder", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FolderProperties" }, { "$ref": "#/components/schemas/FolderRequiredProperties" } ] } } } }, "responses": { "201": { "description": "Created Sub-Folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderProperties" } } } } } }, "get": { "tags": [ "Folders" ], "summary": "List Sub-folders", "operationId": "listSubFolders", "description": "List the sub-folders of a folder\n", "parameters": [ { "in": "path", "name": "folderId", "schema": { "type": "string" }, "required": true, "description": "Folder ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:FOLDER:READ" ] } ], "responses": { "200": { "description": "Folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderListResponse" } } } } } } }, "/hierarchies/publish": { "post": { "tags": [ "Hierarchies Publish" ], "summary": "Publish hierarchy nodes", "operationId": "publishHierarchyNodes", "description": "To publish a hierarchy tree, you need to specify the root node and set getDescendants to true.\n\nTo publish a hierarchy branch, you need to specify the parent node and set getDesendants to true.\n\nTo publish a hierarchy node without any children and set getDescendants to false.\n\nTo publish multiple nodes individually supply their IDs, you cannot publish multiple nodes with getDescendants set to true.\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishHierarchies" } } } }, "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH" ] } ], "responses": { "204": { "description": "No Content Response" } } } }, "/hierarchies/snapshot": { "post": { "tags": [ "Hierarchies Snapshot" ], "summary": "Snapshot hierarchy nodes", "operationId": "snapshotHierarchyNodes", "description": "To snapshot a hierarchy tree, you need to specify the root node and set getDescendants to true.\n\nTo snapshot a hierarchy branch, you need to specify the parent node and set getDesendants to true.\n\nTo snapshot a hierarchy node without any children and set getDescendants to false.\n\nTo snapshot multiple nodes individually supply their IDs, you cannot snapshot multiple nodes with getDescendants set to true.\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotHierarchies" } } } }, "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "201": { "description": "Snapshot", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" } } } } } } }, "/hierarchy-node/{id}/children": { "get": { "tags": [ "Hierarchy Node" ], "summary": "Get Child Hierarchy Nodes", "operationId": "getChildHierarchyNodes", "description": "Get a List of Child Hierarchy Nodes\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "List of Child Hierarchy Nodes", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/HierarchyNodeChildResponse" } ] } } } } } } }, "/hierarchy-node/{id}/parents": { "get": { "tags": [ "Hierarchy Node" ], "summary": "Get Parent Hierarchy Nodes", "operationId": "getParentHierarchyNodes", "description": "Get a List of Parent Hierarchy Nodes\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "List of Parent Hierarchy Nodes", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/HierarchyNodeParentsResponse" } ] } } } } } } }, "/hierarchy-node/{id}/position": { "post": { "tags": [ "Hierarchy Node" ], "summary": "Change a Hierarchy Node's Position", "operationId": "postHierarchyNodePosition", "description": "Change a Hierarchy Node's position\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "responses": { "200": { "description": "List of Hierarchy Node Position Changes", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/HierarchyNodePositionResponse" } ] } } } } } } }, "/hubs": { "get": { "tags": [ "Hubs" ], "summary": "List Hubs", "operationId": "listHubs", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Hub List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubListResponse" } } } } } }, "post": { "tags": [ "Hubs" ], "summary": "Create Hub", "description": "A Hub is a container for multiple repositories including media, content, content types.", "operationId": "createHub", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:HUB:CREATE" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/HubProperties" }, { "$ref": "#/components/schemas/HubRequiredProperties" } ] } } }, "description": "Hub", "required": true }, "responses": { "201": { "description": "Created", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubProperties" } } } } } } }, "/hubs/{hubId}": { "get": { "tags": [ "Hubs" ], "summary": "Get Hub", "description": "Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub", "operationId": "getHub", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Hub response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubProperties" } } }, "links": { "listSnapshots": { "operationId": "listSnapshots", "parameters": { "hubId": "$response.body#/id" }, "description": "The `id` value returned in the response can be used as the `hubId` parameter in `GET /hubs/{hubId}/snapshots`.\n" } } } } }, "patch": { "tags": [ "Hubs" ], "summary": "Update Hub", "description": "Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub", "operationId": "updateHub", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubProperties" } } } }, "responses": { "200": { "description": "Updated Hub response", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubProperties" } } } } } } }, "/hubs/{hubId}/asset-management": { "get": { "tags": [ "Hubs" ], "summary": "Get Hub Asset Management Settings", "operationId": "getHubAssetManagementSettings", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Updated Hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubAssetManagementSettingsResponse" } } } } } }, "put": { "tags": [ "Hubs" ], "summary": "Update Hub Asset Management Settings", "operationId": "updateHubAssetManagementSettings", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubAssetManagementSettings" } } } }, "responses": { "200": { "description": "Updated Hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubAssetManagementSettingsResponse" } } } } } } }, "/hubs/{hubId}/asset-repositories": { "get": { "tags": [ "Hubs" ], "summary": "Get Hub Asset Repositories", "operationId": "getHubAssetRepositories", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Asset Repositories for a Hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubAssetRepositoriesResponse" } } } } } } }, "/hubs/{hubId}/balances": { "get": { "tags": [ "Balances" ], "summary": "Get Balances", "description": "retrieve balances", "operationId": "getBalances", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Balances Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalancesGetResponse" } } } } } } }, "/hubs/{hubId}/bulk-apply-locale": { "post": { "tags": [ "Hubs" ], "summary": "Post Bulk Apply Locale Job", "operationId": "postBulkApplyLocaleJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkApplyLocaleRequest" } } } }, "responses": { "200": { "description": "Bulk Job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkApplyLocaleResponse" } } } } } } }, "/hubs/{hubId}/bulk-apply-locale/{bulkJobId}": { "get": { "tags": [ "Hubs" ], "summary": "Get Bulk Apply Locale Job", "operationId": "getBulkApplyLocaleJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "bulkJobId", "schema": { "type": "string" }, "required": true, "description": "Bulk Job Id", "example": "00112233445566778899bbcc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Get bulk update workflow response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkApplyLocaleResponseWithResults" } } } } } } }, "/hubs/{hubId}/bulk-archive": { "post": { "tags": [ "Hubs" ], "summary": "Post Bulk Archive Job", "operationId": "postBulkArchiveJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - DELETE_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:DELETE" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkArchiveRequest" } } } }, "responses": { "200": { "description": "Bulk Job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkArchiveResponse" } } } } } } }, "/hubs/{hubId}/bulk-archive/{jobId}": { "get": { "tags": [ "Hubs" ], "summary": "Get Bulk Archive Job", "operationId": "getBulkArchiveJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "jobId", "schema": { "type": "string" }, "required": true, "description": "Bulk Job Id", "example": "00112233445566778899bbcc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Get bulk archive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkArchiveResponseWithResults" } } } } } } }, "/hubs/{hubId}/bulk-assign-users": { "post": { "tags": [ "Hubs" ], "summary": "Post Bulk Assign Users Job", "operationId": "postBulkAssignUsersJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAssignUsersRequest" } } } }, "responses": { "200": { "description": "Bulk Job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAssignUsersResponse" } } } } } } }, "/hubs/{hubId}/bulk-assign-users/{jobId}": { "get": { "tags": [ "Hubs" ], "summary": "Get Bulk Assign Users Job", "operationId": "getBulkAssignUsersJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "jobId", "schema": { "type": "string" }, "required": true, "description": "Bulk Job Id", "example": "00112233445566778899bbcc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Get bulk assign users response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAssignUsersResponseWithResults" } } } } } } }, "/hubs/{hubId}/bulk-copy-item": { "post": { "tags": [ "Hubs" ], "summary": "Post Bulk Copy Item Job", "operationId": "postBulkCopyItemJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - CREATE_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCopyItemRequest" } } } }, "responses": { "200": { "description": "Updated Hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCopyItemResponse" } } } } } } }, "/hubs/{hubId}/bulk-copy-item/{jobId}": { "get": { "tags": [ "Hubs" ], "summary": "Get Bulk Copy Item Job", "operationId": "getBulkCopyItemJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "jobId", "schema": { "type": "string" }, "required": true, "description": "Bulk Job Id", "example": "00112233445566778899bbcc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Updated Hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCopyItemResponseWithResults" } } } } } } }, "/hubs/{hubId}/bulk-publish-items": { "post": { "tags": [ "Hubs" ], "summary": "Post Bulk Publish Job", "operationId": "postBulkPublishItems", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkPublishRequest" } } } }, "responses": { "200": { "description": "Bulk Job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkPublishResponse" } } } } } } }, "/hubs/{hubId}/bulk-publish-items/{bulkJobId}": { "get": { "tags": [ "Hubs" ], "summary": "Get Bulk Publish Job", "operationId": "getBulkPublishJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "bulkJobId", "schema": { "type": "string" }, "required": true, "description": "Bulk Job Id", "example": "00112233445566778899bbcc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Get bulk publish response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkPublishResponseWithResults" } } } } } } }, "/hubs/{hubId}/bulk-unarchive": { "post": { "tags": [ "Hubs" ], "summary": "Post Bulk Unarchive Job", "operationId": "postBulkUnarchiveJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUnarchiveRequest" } } } }, "responses": { "200": { "description": "Updated Hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUnarchiveResponse" } } } } } } }, "/hubs/{hubId}/bulk-unarchive/{jobId}": { "get": { "tags": [ "Hubs" ], "summary": "Get Bulk Unarchive Job", "operationId": "getBulkUnarchiveJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "jobId", "schema": { "type": "string" }, "required": true, "description": "Bulk Job Id", "example": "00112233445566778899bbcc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Updated Hub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUnarchiveResponseWithResults" } } } } } } }, "/hubs/{hubId}/bulk-update-workflow": { "post": { "tags": [ "Hubs" ], "summary": "Post Bulk Update Workflow Job", "operationId": "postBulkUpdateWorkflowJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: ContentRepository - EDIT_CONTENT", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateWorkflowRequest" } } } }, "responses": { "200": { "description": "Bulk Job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateWorkflowResponse" } } } } } } }, "/hubs/{hubId}/bulk-update-workflow/{bulkJobId}": { "get": { "tags": [ "Hubs" ], "summary": "Get Bulk Update Workflow Job", "operationId": "getBulkUpdateWorkflowJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "bulkJobId", "schema": { "type": "string" }, "required": true, "description": "Bulk Job Id", "example": "00112233445566778899bbcc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Get bulk update workflow response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateWorkflowResponseWithResults" } } } } } } }, "/hubs/{hubId}/content-items/facet": { "post": { "tags": [ "Content Items" ], "summary": "Faceting Content Items with Search by Text", "operationId": "facetingContentItemsWithSearchByText", "description": "Facet content items and search by text. See [Text Search Query Syntax](#section/Text-Search-Query-Syntax) for a summary of the query syntax.\n", "parameters": [ { "$ref": "#/components/parameters/hubId" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sort", "required": false, "example": "createdDate" }, { "in": "query", "name": "createdDate.dir", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "Direction of sort", "required": false, "example": "desc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "requestBody": { "description": "Facet Content Items", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "facetAs": { "description": "Facet As", "type": "string", "example": "ENUM" }, "filter": { "type": "object", "properties": { "type": { "description": "Type", "type": "string", "example": "EQ" }, "value": { "description": "Values", "type": "array", "example": [ "http://deliver.bigcontent.io/schema/nested/nested-type.json" ] } } }, "field": { "description": "Field", "type": "string", "example": "schema" }, "userFacingName": { "description": "User Facing Name", "type": "string", "example": "Schema" } } } }, "returnEntities": { "description": "Return Entities", "type": "boolean", "example": true } } } } } }, "responses": { "200": { "description": "Content Item Facet response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemFindResponse" }, { "type": "object", "properties": { "_facets": { "type": "object", "properties": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "description": "ID", "type": "string", "example": "http://deliver.bigcontent.io/schema/nested/nested-type.json" }, "count": { "description": "Count", "type": "number", "example": 1 } } } } } } } } ] } } } } } } }, "/hubs/{hubId}/content-items/filter": { "post": { "tags": [ "Content Items" ], "summary": "Filtering Content Items by Collection Keys", "operationId": "filteringContentItemsByCollectionKeys", "description": "Filter content items using Collection Keys.\n", "parameters": [ { "$ref": "#/components/parameters/hubId" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "requestBody": { "description": "Filter Content Items", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "collectionKey" ], "properties": { "collectionKey": { "type": "string", "description": "collectionKey", "example": "hubName:527c95fd10c77e96b5164633b445271ffc0392031b6c99448cbaec579767b76b" }, "sortBy": { "type": "object", "properties": { "order": { "type": "string", "description": "sort order", "enum": [ "asc", "desc" ], "example": "asc" } } }, "page": { "type": "object", "properties": { "cursor": { "type": "string", "description": "next page cursor", "example": "SSBhbSBhIGhhdGNoZWQtZWFzdGVyLWVnZy4gUGxlYXNlIGRvbid0IGRlY29kZSBtZS4=" }, "size": { "type": "integer" } } } } } } } }, "responses": { "200": { "description": "Content Item filter response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemFilterResponse" } ] } } } } } } }, "/hubs/{hubId}/content-items/find": { "get": { "tags": [ "Content Items" ], "summary": "Search Content Items by Text", "operationId": "searchContentItemsByText", "description": "Text is the default search field. See [Text Search Query Syntax](#section/Text-Search-Query-Syntax) for a summary of the query syntax.\n", "parameters": [ { "$ref": "#/components/parameters/hubId" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Query", "required": true, "example": "uniondusk" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Search Content Items by Text response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemFindResponse" } } } } } } }, "/hubs/{hubId}/content-repositories": { "post": { "tags": [ "Content Repositories" ], "summary": "Create Content Repository", "operationId": "createContentRepository", "description": "Create a new Content Repository\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - CREATE_REPOSITORY", "FN: CONTENT:FUNCTIONAL:REPOSITORY:CREATE" ] } ], "requestBody": { "description": "Content Repository", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentRepositoryProperties" }, { "$ref": "#/components/schemas/ContentRepositoryRequiredProperties" } ] } } } }, "responses": { "201": { "description": "Created Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } } } }, "get": { "tags": [ "Content Repositories" ], "summary": "List Content Repositories", "operationId": "listContentRepository", "description": "List Content Repositories for a Hub\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "label,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:REPOSITORY:READ" ] } ], "responses": { "200": { "description": "Paginated Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryListResponseWithSearch" } } } } } } }, "/hubs/{hubId}/content-repositories/search/findByFeaturesContaining": { "get": { "tags": [ "Content Repositories" ], "summary": "Find by feature", "operationId": "findContentRepositoryWithFeature", "description": "Find all the Content Repositories that contain a feature\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "feature", "schema": { "type": "string" }, "required": true, "description": "Feature", "example": "slots" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "label,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:REPOSITORY:READ" ] } ], "responses": { "200": { "description": "Paginated Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentRepositoryListResponse" } } } } } } }, "/hubs/{hubId}/content-types": { "post": { "tags": [ "Content Types" ], "summary": "Create Content Type", "operationId": "createContentType", "description": "Create a new Content Type\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_TYPE:CREATE" ] } ], "requestBody": { "description": "Content Type", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "required": [ "contentTypeUri" ], "properties": { "contentTypeUri": { "readOnly": false, "type": "string", "description": "Content Type URI", "example": "http://example.com/content-type.json" } } }, { "$ref": "#/components/schemas/ContentTypeProperties" }, { "$ref": "#/components/schemas/ContentTypeRequiredProperties" } ] } } } }, "responses": { "201": { "description": "Created Content Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeProperties" } } } } } }, "get": { "tags": [ "Content Types" ], "summary": "List Content Types", "operationId": "listContentTypes", "description": "List Content Types for a Hub\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "contentTypeUri,asc" }, { "in": "query", "name": "status", "schema": { "type": "string" }, "required": false, "description": "Comma seperated list of statuses", "example": "ACTIVE,ARCHIVED" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_TYPE:READ" ] } ], "responses": { "200": { "description": "Paginated Content Types", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeListResponse" } } } } } } }, "/hubs/{hubId}/deep-sync-job": { "post": { "tags": [ "Jobs" ], "summary": "Create Deep Sync Job", "description": "create new deep sync job", "operationId": "createDeepSyncJobs", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreateDeepSyncRequest" } } } }, "responses": { "200": { "description": "List Job response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreateDeepSyncResponse" } } } } } } }, "/hubs/{hubId}/delivery-keys/content-item": { "get": { "tags": [ "Content Items" ], "summary": "Finding Content Items by Delivery Keys", "operationId": "findContentItemsByDeliveryKeys", "description": "Find content items using the Delivery Key.\n", "parameters": [ { "$ref": "#/components/parameters/hubId" }, { "in": "query", "name": "key", "schema": { "type": "string" }, "required": true, "description": "The delivery key", "example": "promo-page/main-banner" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:READ" ] } ], "responses": { "200": { "description": "Content Item", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemRequiredProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] } } } } } } }, "/hubs/{hubId}/events": { "get": { "tags": [ "Events" ], "summary": "List Events", "operationId": "listEvents", "description": "List all of the Events created for a hub\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Event List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventListResponse" } } } } } }, "post": { "tags": [ "Events" ], "summary": "Create a new Event", "operationId": "createEvent", "description": "Create a new Event for a particular Hub.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:EVENT:CREATE", "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EventProperties" }, { "$ref": "#/components/schemas/EventRequiredProperties" } ] } } }, "required": true }, "responses": { "200": { "description": "The created Event", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventProperties" } } } } } } }, "/hubs/{hubId}/extensions": { "get": { "tags": [ "Extensions" ], "summary": "List Extensions", "operationId": "listExtensions", "description": "List all of the extension created for a hub.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "createdDate,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:UI_EXTENSION:READ" ] } ], "responses": { "200": { "description": "Paginated Extension List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionListResponse" } } } } } }, "post": { "tags": [ "Extensions" ], "summary": "Create Extension", "operationId": "createExtension", "description": "Create a new Extension.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:UI_EXTENSION:CREATE" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } }, "required": true }, "responses": { "200": { "description": "Create Extension", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } } } } }, "/hubs/{hubId}/extensions/{name}": { "get": { "tags": [ "Extensions" ], "summary": "Get Extension by name", "operationId": "getExtensionByName", "description": "Return the extension with the specified name, in current hub.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "name", "schema": { "type": "string" }, "required": true, "description": "Extension name", "example": "sample-name" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:UI_EXTENSION:READ" ] } ], "responses": { "200": { "description": "Extension Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } } } } }, "/hubs/{hubId}/integrations": { "get": { "tags": [ "Integrations" ], "summary": "List Available Integrations", "operationId": "listIntegrations", "description": "List all of the Integrations created for a hub (dependent on functional permissions)\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": [ "label", "asc" ] } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFMC:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Integration List", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationListResponse" }, { "required": [ "_embedded", "_links", "page" ] } ] } } } } } } }, "/hubs/{hubId}/jobs": { "post": { "tags": [ "Jobs" ], "summary": "List Job", "description": "retrieve jobs", "operationId": "listJobs", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobListRequest" } } } }, "responses": { "200": { "description": "List Job response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobListResponse" } } } } } } }, "/hubs/{hubId}/jobs/{jobId}": { "get": { "tags": [ "Jobs" ], "summary": "Get Job", "description": "retrieve job", "operationId": "getJob", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "jobId", "schema": { "type": "string" }, "required": true, "description": "Job Id", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Job response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobGetResponse" } } } } } } }, "/hubs/{hubid}/linked-content-repositories": { "get": { "tags": [ "Content Repository Mapping" ], "summary": "List Linked Content Repositories", "operationId": "listLinkedContentRepository", "description": "List the mapping relationships between two Hubs\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS" ] } ], "responses": { "200": { "description": "List Linked Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLinkedContentRepositoriesResponse" } } } } } }, "put": { "tags": [ "Hubs" ], "summary": "Create Linked Content Repositories", "operationId": "linkedContentRepository", "description": "Create a link for content repositories between different hubs to allow the coping or syncing of content\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedContentRepositoriesRequest" } } } }, "responses": { "200": { "description": "Created Linked Content Repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedContentRepositoriesResponse" } } } } } } }, "/hubs/{hubId}/locale-labels": { "get": { "tags": [ "Locale Labels" ], "summary": "Read Local Labels", "description": "Get a list of locals and labels", "operationId": "readLocalLabels", "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageLocaleLabelsResponse" } } } } } }, "put": { "tags": [ "Locale Labels" ], "summary": "Manage Locale Labels", "description": null, "operationId": "manageLocalLabels", "security": [ { "oauth2": [ "FN: \"CONTENT:FUNCTIONAL:HUB:EDIT\"", "ACL: Hub - READ", "ACL: Hub - EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ManageLocaleLabelsRequest" } ] } } }, "description": "Hub", "required": true }, "responses": { "200": { "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageLocaleLabelsResponse" } } } } } } }, "/hubs/{hubId}/plan": { "patch": { "tags": [ "Hubs" ], "summary": "Update Hub Plan", "operationId": "updateHubPlan", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT", "FN: CONTENT:FUNCTIONAL:HUB:EDIT", "FN: CONTENT:FUNCTIONAL:HUB:MANAGE_PLAN" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "plan": { "$ref": "#/components/schemas/HubPlan" } } } } } }, "responses": { "204": { "description": "Updated Hub", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } } } } } }, "/hubs/{hubId}/settings": { "patch": { "tags": [ "Hubs" ], "summary": "Update Hub Settings", "operationId": "updateHubSettings", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubSettings" } } } }, "responses": { "204": { "description": "Updated Hub", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } } } } } }, "/hubs/{hubId}/share": { "post": { "tags": [ "Hubs" ], "summary": "Share Hub", "description": "Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub", "operationId": "shareHub", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - SHARE" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubShare" } } } }, "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } } } } } }, "/hubs/{hubId}/snapshots": { "get": { "tags": [ "Snapshots" ], "summary": "List Snapshots", "operationId": "listSnapshots", "description": "List all of the snapshots created for a hub. The list can be filtered by user or system created snapshots.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "createdDate,asc" }, { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "user", "system", "generated" ] }, "required": false, "description": "Type filter", "example": "user" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Snapshot List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotListResponse" } } } } } }, "post": { "tags": [ "Snapshots" ], "summary": "Create Snapshot", "operationId": "createSnapshot", "description": "Create a new Snapshot for a particular Content-Item.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" } } }, "required": true }, "responses": { "201": { "description": "Paginated Snapshot List", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" } } } } } } }, "/hubs/{hubId}/snapshots/batch": { "post": { "tags": [ "Snapshots" ], "summary": "Create Batch of Snapshot", "operationId": "createSnapshotBatch", "description": "Create new Snapshots for a batch of Content Items.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCreateSnapshotRequest" } } }, "required": true }, "responses": { "201": { "description": "Paginated Snapshot List", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCreateSnapshotResponse" } } } } } } }, "/hubs/{hubId}/snapshots/search": { "get": { "tags": [ "Snapshots" ], "summary": "Search Snapshots", "operationId": "searchSnapshotLinks", "description": "List all of the support search queries for a Snapshot\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Snapshot Search Links", "content": { "application/json": { "schema": { "type": "object", "properties": { "_links": { "type": "object", "properties": { "facet": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Snapshot Facet URL" } ] }, "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self Link" } ] } } } } } } } } } } }, "/hubs/{hubId}/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "List Webhooks for a Hub", "operationId": "listWebhooks", "description": "List all of the Webhooks created for a hub", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": [ "createdDate", "asc" ] } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:WEBHOOK:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Webhook List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookListResponse" } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Create Webhooks", "operationId": "createWebhook", "description": "Create a new Webhook for a Hub\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:WEBHOOK:CREATE", "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebhookProperties" }, { "$ref": "#/components/schemas/WebhookRequiredProperties" } ] } } }, "required": true }, "responses": { "201": { "description": "Created Webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookProperties" } } } } } } }, "/hubs/{hubId}/webhooks/{webhookId}": { "get": { "tags": [ "Webhooks" ], "summary": "Get a Webhook", "operationId": "getWebhook", "description": "Get a specified webhook", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "webhookId", "schema": { "type": "string" }, "required": true, "description": "Webhook ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:WEBHOOK:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Webhook Request List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookProperties" } } } } } }, "patch": { "tags": [ "Webhooks" ], "summary": "Update a Webhook", "operationId": "updateWebhook", "description": "Update a specified webhook", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "webhookId", "schema": { "type": "string" }, "required": true, "description": "Webhook ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:WEBHOOK:EDIT", "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookProperties" } } } }, "responses": { "200": { "description": "Webhook Request List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookProperties" } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete a Webhook", "operationId": "deleteWebhook", "description": "Delete a specified webhook", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "webhookId", "schema": { "type": "string" }, "required": true, "description": "Webhook ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:WEBHOOK:DELETE", "ACL: Hub - READ" ] } ], "responses": { "204": { "description": "No content" } } } }, "/hubs/{hubId}/webhooks/{webhookId}/requests": { "get": { "tags": [ "Webhooks" ], "summary": "List Requests for a Webhook", "operationId": "listWebhookRequests", "description": "List all of the requests created for a webhook", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "webhookId", "schema": { "type": "string" }, "required": true, "description": "Webhook ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:WEBHOOK:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Webhook Request List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequestListResponse" } } } } } } }, "/hubs/{hubId}/webhooks/{webhookId}/requests/{requestId}": { "get": { "tags": [ "Webhooks" ], "summary": "Get a Webhook Request", "operationId": "getWebhookRequest", "description": "Get a single webhook request", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "webhookId", "schema": { "type": "string" }, "required": true, "description": "Webhook ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "requestId", "schema": { "type": "string" }, "required": true, "description": "Webhook Request ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:WEBHOOK:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Webhook Request Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } } } } } }, "/hubs/{hubId}/webhooks/{webhookId}/requests/{requestId}/preview": { "post": { "tags": [ "Webhooks" ], "summary": "Preview Webhook Request", "operationId": "previewWebhookRequest", "description": "You can test your unsaved Webhook Subscription against an already sent Webhook Request \n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "webhookId", "schema": { "type": "string" }, "required": true, "description": "Webhook ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "requestId", "schema": { "type": "string" }, "required": true, "description": "Webhook Request ID", "example": "00112233445566778899aabb" } ], "requestBody": { "description": "Unsaved Webhook Subscription", "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "$ref": "#/components/schemas/WebhookHandler" }, "method": { "$ref": "#/components/schemas/WebhookMethod" }, "secret": { "$ref": "#/components/schemas/WebhookSecret" }, "filters": { "$ref": "#/components/schemas/WebhookFilters" }, "headers": { "$ref": "#/components/schemas/WebhookHeaders" }, "customPayload": { "$ref": "#/components/schemas/WebhookCustomPayload" } }, "required": [ "url", "method", "secret" ] } } } }, "responses": { "200": { "description": "Webhook Request Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "previewState", "evaluatedFilters", "_links" ], "properties": { "previewState": { "type": "string", "example": "SUCCESS", "enum": [ "SUCCESS", "PROCESSING_FAILED", "FILTERED" ] }, "request": { "$ref": "#/components/schemas/WebhookHttpRequest" }, "evaluatedFilters": { "$ref": "#/components/schemas/WebhookRequestEvaluatedFilters" }, "customPayload": { "$ref": "#/components/schemas/WebhookCustomPayload" }, "_links": { "type": "object", "properties": { "request": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests/00112233445566778899aabb" } } } } } } } } } } } } }, "/hubs/{hubId}/webhooks/{webhookId}/requests/{requestId}/resend": { "post": { "tags": [ "Webhooks" ], "summary": "Resend a Webhook Request", "operationId": "resendWebhookRequest", "description": "Only available for Webhook Requests that have a `requestState` that is either \"SUCCESS\", \"FAILED\" or \"PROCESSING_FAILED\"\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "webhookId", "schema": { "type": "string" }, "required": true, "description": "Webhook ID", "example": "00112233445566778899aabb" }, { "in": "path", "name": "requestId", "schema": { "type": "string" }, "required": true, "description": "Webhook Request ID", "example": "00112233445566778899aabb" } ], "requestBody": { "description": "Resend Webhook Request (empty object)", "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Webhook Request Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } } } } } }, "/hubs/{hubId}/workflow-states": { "post": { "tags": [ "Workflows" ], "summary": "Create Workflow State", "operationId": "createWorkflowState", "description": "You may create up to 100 workflow states per hub.\n\nThe `color` property is an RGB value representing the color which should be used to display the workflow state within Dynamic Content.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT_WORKFLOW_STATES" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkflowStateProperties" }, { "$ref": "#/components/schemas/WorkflowStateRequiredProperties" } ] } } }, "required": true }, "responses": { "201": { "description": "Created Snapshot List", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkflowStateProperties" }, { "$ref": "#/components/schemas/WorkflowStateRequiredProperties" } ] } } } } } }, "get": { "tags": [ "Workflows" ], "summary": "List Workflow States", "operationId": "listWorkflowStates", "description": "List all of the workflow stats for a hub.\n", "parameters": [ { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": [ "createdDate", "asc" ] } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated Snapshot List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowStateListResponse" } } } } } } }, "/integrations/sfcc": { "get": { "tags": [ "Salesforce Commerce Cloud (SFCC)" ], "summary": "List SFCC Integrations", "operationId": "listSfccIntegrations", "description": "List all of the SFCC Integrations\n", "parameters": [ { "in": "query", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "required": false, "description": "Cursor specific to a page" }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": [ "label", "asc" ] } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated SFCC Integrations List", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SfccIntegrationListResponse" }, { "required": [ "_embedded", "_links", "page" ] } ] } } } } } }, "post": { "tags": [ "Salesforce Commerce Cloud (SFCC)" ], "summary": "Create SFCC Integration", "operationId": "createSfccIntegration", "description": "Create a SFCC Integration\n", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:CREATE", "FN: CONTENT:FUNCTIONAL:WEBHOOK:CREATE", "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "hubId": { "readOnly": false } } }, { "$ref": "#/components/schemas/SfccIntegrationProperties" }, { "$ref": "#/components/schemas/SfccIntegrationRequiredProperties" } ] } } } }, "responses": { "200": { "description": "SFCC Integration Create Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SfccIntegrationProperties" }, { "$ref": "#/components/schemas/SfccIntegrationRequiredProperties" } ] } } } } } } }, "/integrations/sfcc/{integrationId}": { "get": { "tags": [ "Salesforce Commerce Cloud (SFCC)" ], "summary": "Get a SFCC Integration", "operationId": "getSfccIntegration", "description": "Get a specific SFCC Integration\n", "parameters": [ { "in": "path", "name": "integrationId", "schema": { "type": "string" }, "required": true, "description": "Integration ID", "example": "00112233-4455-6677-8899-aabbccddeeff" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Requested SFCC Integration", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SfccIntegrationProperties" }, { "$ref": "#/components/schemas/SfccIntegrationRequiredProperties" } ] } } } } } }, "patch": { "tags": [ "Salesforce Commerce Cloud (SFCC)" ], "summary": "Update SFCC Integration", "operationId": "updateSfccIntegration", "description": "Update an SFCC Integration\n", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:EDIT", "FN: CONTENT:FUNCTIONAL:WEBHOOK:CREATE", "FN: CONTENT:FUNCTIONAL:WEBHOOK:EDIT", "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SfccIntegrationProperties" } } } }, "responses": { "200": { "description": "SFCC Integration Update Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SfccIntegrationProperties" }, { "$ref": "#/components/schemas/SfccIntegrationRequiredProperties" } ] } } } } } }, "delete": { "tags": [ "Salesforce Commerce Cloud (SFCC)" ], "summary": "Delete SFCC Integration", "operationId": "deleteSfccIntegration", "description": "Delete an SFCC Integration\n", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:DELETE", "FN: CONTENT:FUNCTIONAL:WEBHOOK:DELETE", "ACL: Hub - READ" ] } ], "responses": { "204": { "description": "No Content" } } } }, "/integrations/sfmc": { "get": { "tags": [ "Salesforce Marketing Cloud (SFMC)" ], "summary": "List SFMC Integrations", "operationId": "listSfmcIntegrations", "description": "List all of the SFMC Integrations\n", "parameters": [ { "in": "query", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "required": false, "description": "Cursor specific to a page" }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": [ "label", "asc" ] } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFMC:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Paginated SFMC Integrations List", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SfmcIntegrationListResponse" }, { "required": [ "_embedded", "_links", "page" ] } ] } } } } } }, "post": { "tags": [ "Salesforce Marketing Cloud (SFMC)" ], "summary": "Create SFMC Integration", "operationId": "createSfmcIntegration", "description": "Create a SFMC Integration\n", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFMC:CREATE", "FN: CONTENT:FUNCTIONAL:WEBHOOK:CREATE", "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "hubId": { "readOnly": false } } }, { "$ref": "#/components/schemas/SfmcIntegrationProperties" }, { "$ref": "#/components/schemas/SfmcIntegrationRequiredProperties" } ] } } } }, "responses": { "200": { "description": "SFMC Integration Create Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SfmcIntegrationProperties" }, { "$ref": "#/components/schemas/SfmcIntegrationRequiredProperties" } ] } } } } } } }, "/integrations/sfmc/{integrationId}": { "get": { "tags": [ "Salesforce Marketing Cloud (SFMC)" ], "summary": "Get a SFMC Integration", "operationId": "getSfmcIntegration", "description": "Get a specific SFMC Integration\n", "parameters": [ { "in": "path", "name": "integrationId", "schema": { "type": "string" }, "required": true, "description": "Integration ID", "example": "00112233-4455-6677-8899-aabbccddeeff" } ], "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFMC:READ", "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Requested SFMC Integration", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SfmcIntegrationProperties" }, { "$ref": "#/components/schemas/SfmcIntegrationRequiredProperties" } ] } } } } } }, "patch": { "tags": [ "Salesforce Marketing Cloud (SFMC)" ], "summary": "Update SFMC Integration", "operationId": "updateSfmcIntegration", "description": "Update an SFMC Integration\n", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFMC:EDIT", "FN: CONTENT:FUNCTIONAL:WEBHOOK:CREATE", "FN: CONTENT:FUNCTIONAL:WEBHOOK:EDIT", "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SfmcIntegrationProperties" } } } }, "responses": { "200": { "description": "SFMC Integration Update Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SfmcIntegrationProperties" }, { "$ref": "#/components/schemas/SfmcIntegrationRequiredProperties" } ] } } } } } }, "delete": { "tags": [ "Salesforce Marketing Cloud (SFMC)" ], "summary": "Delete SFMC Integration", "operationId": "deleteSfmcIntegration", "description": "Delete an SFMC Integration\n", "security": [ { "oauth2": [ "FN: CONTENT:FUNCTIONAL:INTEGRATIONS:READ", "FN: PLATFORM_INTEGRATION:FUNCTIONAL:SFMC:DELETE", "FN: CONTENT:FUNCTIONAL:WEBHOOK:DELETE", "ACL: Hub - READ" ] } ], "responses": { "204": { "description": "No Content" } } } }, "/localization-jobs/search/findByRootContentItem/{id}": { "get": { "tags": [ "Localization" ], "summary": "Localization Jobs", "operationId": "localizationJobs", "description": "Content item localization is performed asynchronously - the request to localize a content item graph creates a Localization Job which will be completed at some point in the future. It is possible to track the status of these jobs.\n", "parameters": [ { "$ref": "#/components/parameters/contentItemIdPath" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Localization Jobs response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalizationJobs" } } } } } } }, "/publishing-jobs/{publishingJobId}": { "get": { "tags": [ "Publishing Jobs" ], "summary": "Get a Publishing Job", "operationId": "getPublishingJob", "description": "Get a Publishing Job", "parameters": [ { "in": "path", "name": "publishingJobId", "schema": { "type": "string" }, "required": true, "description": "Publishing Job ID" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "A Publishing Job response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishingJob" } } } } } }, "patch": { "tags": [ "Publishing Jobs" ], "summary": "Cancelling a Publishing Job", "operationId": "cancellingPublishingJob", "description": "Canelling a Publishing Job\n", "parameters": [ { "in": "path", "name": "publishingJobId", "schema": { "type": "string" }, "required": true, "description": "Publishing Job ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "FN: CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "state" ], "properties": { "state": { "type": "string", "description": "Assign state to \"CANCELLED\"", "example": "CANCELLED" } } } } } }, "responses": { "200": { "description": "Successfully created a Publishing Job", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishingJob" }, { "type": "object", "required": [ "state" ], "properties": { "state": { "type": "string", "description": "Assign state to \"CANCELLED\"", "example": "CANCELLED" } } } ] } } } } } } }, "/snapshots/{snapshotId}": { "get": { "tags": [ "Snapshots" ], "summary": "Get Snapshot", "operationId": "getSnapshot", "description": "Return the snapshot with the specified ID.\n", "parameters": [ { "in": "path", "name": "snapshotId", "schema": { "type": "string" }, "required": true, "description": "Snapshot ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Snapshot Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" } } } } } } }, "/snapshots/{snapshotId}/edition-links": { "get": { "tags": [ "Snapshots", "Editions" ], "summary": "Get Snapshot Edition Links", "operationId": "getSnapshotEditionLink", "description": "Return a list of edition links for the specified snapshot.
Simply follow the HAL link with rel \"snapshot-edition-links\" from a snapshot response.", "parameters": [ { "in": "path", "name": "snapshotId", "schema": { "type": "string" }, "required": true, "description": "Snapshot ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "createdDate,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Snapshot Edition Get Links Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotEditionLinkListResponse" } } } } } }, "post": { "tags": [ "Snapshots" ], "summary": "Create Snapshot Edition Link", "operationId": "createSnapshotEditionLink", "description": "Create a link between the specified snapshot and edition.\n", "parameters": [ { "in": "path", "name": "snapshotId", "schema": { "type": "string" }, "required": true, "description": "Snapshot ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotEditionLink" } } } }, "responses": { "200": { "description": "Snapshot Edition Link Create Response", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotEditionLink" } } } } } } }, "/snapshots/{snapshotId}/edition-links/{editionId}": { "delete": { "tags": [ "Snapshots", "Editions" ], "summary": "Delete Snapshot Edition Link", "operationId": "deleteSnapshotEditionLink", "description": "Delete a Snapshot Edition Link", "parameters": [ { "in": "path", "name": "editionId", "schema": { "type": "string" }, "required": true, "description": "Edition ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "204": { "description": "Successfully removed the Snapshot Edition link" } } } }, "/snapshots/{snapshotId}/publishing-jobs": { "get": { "tags": [ "Snapshots", "Publishing Jobs" ], "summary": "List all publishing jobs for a Snapshot", "operationId": "getSnapshotPublishingJobs", "description": "Get a list of all Publishing Jobs for a Snapshot", "parameters": [ { "in": "path", "name": "snapshotId", "schema": { "type": "string" }, "required": true, "description": "Snapshot ID" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort paramter", "example": "createdDate,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "List of all publishing jobs for a Snapshot Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishingJobListResponse" } } } } } }, "post": { "tags": [ "Snapshots", "Publishing Jobs" ], "summary": "Create Publishing-Job for Snapshot", "operationId": "createSnapshotPubishingJob", "description": "Create a Publishing Job for a Snapshot\n", "parameters": [ { "in": "path", "name": "snapshotId", "schema": { "type": "string" }, "required": true, "description": "Snapshot ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishingJob" } } } }, "responses": { "200": { "description": "Successfully created a Publishing Job", "headers": { "Location": { "schema": { "$ref": "#/components/schemas/LocationHeader" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishingJob" } } } } } } }, "/snapshots/search/facet": { "post": { "tags": [ "Snapshots" ], "summary": "Snapshot Facets", "operationId": "snapshotSearchFacet", "description": "Add a search facet to a snapshot.\n", "parameters": [ { "in": "query", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "required": false, "description": "Page number", "example": 0 }, { "in": "query", "name": "size", "schema": { "type": "integer" }, "required": false, "description": "Page size", "example": 20 }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "required": false, "description": "Sort", "example": "createdDate,asc" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotFacet" }, "examples": { "singleFacet": { "summary": "Single Facet", "value": { "fields": [ { "facetAs": "ENUM", "field": "taggedEditions.editionId", "userFacingName": "editionId" } ], "returnEntities": false } }, "basicDateRanges": { "summary": "Basic Date Ranges", "value": { "fields": [ { "facetAs": "DATE", "name": "60 days +", "range": { "start": "-60:DAYS", "end": "-9999:YEARS" }, "field": "createdDate", "userFacingName": "60 days +" }, { "facetAs": "DATE", "name": "Last 60 days", "range": { "start": "-60:DAYS", "end": "NOW" }, "field": "createdDate", "userFacingName": "Last 60 days" }, { "facetAs": "DATE", "name": "Last 30 days", "range": { "start": "-30:DAYS", "end": "NOW" }, "field": "createdDate", "userFacingName": "Last 30 days" }, { "facetAs": "DATE", "name": "Last 14 days", "range": { "start": "-14:DAYS", "end": "NOW" }, "field": "createdDate", "userFacingName": "Last 14 days" }, { "facetAs": "DATE", "name": "Last 7 days", "range": { "start": "-7:DAYS", "end": "NOW" }, "field": "createdDate", "userFacingName": "Last 7 days" } ], "returnEntities": false } } } } }, "required": true }, "responses": { "200": { "description": "Paginated Snapshot List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotFacet" }, "examples": { "singleFacet": { "summary": "Single Facet", "value": { "_links": { "self": { "href": "https://api.amplience.net/v2/content/snapshots/search/facet?hubId=5d36b6cc46e0fb03cc4b27b4" } }, "_facets": { "editionId": [ { "_id": "5d36b6cc46e0fb03cc4b27b6", "count": 104 }, { "_id": "5d36b6cc46e0fb03cc4b27b8", "count": 52 }, { "_id": "5d36b6cc46e0fb03cc4b27b7", "count": 52 } ] } } }, "basicDateRanges": { "summary": "Basic Date Ranges", "value": { "_links": { "self": { "href": "https://api.amplience.net/v2/content/snapshots/search/facet?hubId=5d36b6cb46e0fb03cc4b25f6" } }, "_facets": { "Last 30 days": [ { "_id": "-30:DAYS,NOW", "count": 15 } ], "Last 14 days": [ { "_id": "-14:DAYS,NOW", "count": 6 } ], "Last 60 days": [ { "_id": "-60:DAYS,NOW", "count": 27 } ], "Last 7 days": [ { "_id": "-7:DAYS,NOW", "count": 3 } ], "60 days +": [ { "_id": "-9999:YEARS,-60:DAYS", "count": 129 } ] } } } } } } } } } }, "/workflow-states/{workflowStateId}": { "get": { "tags": [ "Workflows" ], "summary": "Get Workflow State", "operationId": "getWorkflowState", "description": "Returns the workflow state with the specified ID.\n", "parameters": [ { "in": "path", "name": "workflowStateId", "schema": { "type": "string" }, "required": true, "description": "Workflow State ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ" ] } ], "responses": { "200": { "description": "Workflow State Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkflowStateProperties" }, { "$ref": "#/components/schemas/WorkflowStateRequiredProperties" } ] } } } } } }, "patch": { "tags": [ "Workflows" ], "summary": "Update Workflow State", "operationId": "updateWorkflowState", "description": "Update the workflow state\n", "parameters": [ { "in": "path", "name": "workflowStateId", "schema": { "type": "string" }, "required": true, "description": "Workflow State ID", "example": "00112233445566778899aabb" } ], "security": [ { "oauth2": [ "ACL: Hub - READ", "ACL: Hub - EDIT_WORKFLOW_STATES" ] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkflowStateProperties" }, { "type": "object", "properties": { "label": { "example": "Updated State" }, "color": { "example": "rgb(255,255,255)" } } } ] } } }, "required": true }, "responses": { "200": { "description": "Updated Workflow State Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkflowStateProperties" }, { "type": "object", "properties": { "label": { "example": "Updated State" }, "color": { "example": "rgb(255,255,255)" } } } ] } } } } } } } }, "components": { "schemas": { "AdminAccessResponse": { "type": "object", "required": [ "_links" ], "properties": { "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "hub", "content-repository" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/access" } } } ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Manage Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/access/hubs/{id}" } } } ] }, "content-repository": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Manage Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/access/content-repositories/{id}" } } } ] } } } } }, "AdminMembersListResponse": { "allOf": [ { "type": "object", "required": [ "_embedded" ], "properties": { "_embedded": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } } } } }, { "$ref": "#/components/schemas/HalResponse" }, { "type": "object", "required": [ "_links" ], "properties": { "_links": { "type": "object", "required": [ "self" ], "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members" } } } } } } } ] }, "AdminModulesResponse": { "type": "object", "required": [ "_links" ], "properties": { "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "hub" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/modules" } } } ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Manage Hub Modules HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/modules/hubs/{id}" } } } ] } } } } }, "AdminOperationsListHubModulesResponse": { "type": "object", "properties": { "_links": { "type": "object", "required": [ "self", "enable-content-delivery-2" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/modules/hubs/5d5bc260c9e77c035fee1c6e" } } } ] }, "enable-content-delivery-2": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Enable Content Delivery 2 Module HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/modules/hubs/5d5bc260c9e77c035fee1c6e/content-delivery-2" } } } ] }, "enable-algolia-search": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Enable Algolia Search Module HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/modules/hubs/5d5bc260c9e77c035fee1c6e/algolia-search" } } } ] } } } } }, "AdminOperationsListResponse": { "type": "object", "properties": { "_links": { "type": "object", "required": [ "self", "members", "member" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/access/hubs/5d5bc260c9e77c035fee1c6e" } } } ] }, "members": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Members HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/access/hubs/5d5bc260c9e77c035fee1c6e/members" } } } ] }, "member": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Member HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/access/hubs/5d5bc260c9e77c035fee1c6emembers/{sid}" } } } ] } } } } }, "AdminResponse": { "type": "object", "properties": { "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin" } } } ] }, "access": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Manage Access HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/access" } } } ] }, "modules": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Manage Modules HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/admin/modules" } } } ] } } } } }, "AlgoliaSearchIndex": { "type": "object", "required": [ "id", "name", "suffix", "label", "type", "assignedContentTypes", "createdDate", "lastModifiedDate", "_links" ], "properties": { "id": { "$ref": "#/components/schemas/Id" }, "parentId": { "description": "ID of the replicas parent index", "type": "string", "example": "00112233445566778899aabb", "readOnly": true }, "replicaCount": { "description": "Number of replica indexes for this index (only present on non-replica indexes)", "type": "number", "example": 0, "readOnly": true }, "name": { "type": "string", "maxLength": 255, "example": "anya-finn.my-index", "description": "Generated index name including the hub name and user defined suffix", "readOnly": true }, "suffix": { "type": "string", "minLength": 3, "maxLength": 63, "pattern": "/^((?![/~,\\\\`&|;$\\*]).)*$/", "example": "my-index", "description": "Index suffix" }, "label": { "type": "string", "minLength": 3, "maxLength": 63, "example": "My Index", "description": "User defined index label" }, "type": { "description": "Type of index", "type": "string", "enum": [ "PRODUCTION", "STAGING" ] }, "assignedContentTypes": { "writeOnly": true, "description": "Assigned Content Types", "type": "array", "items": { "$ref": "#/components/schemas/AlgoliaSearchIndexAssignedContentType" } }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "status": { "type": "string", "description": "Status", "enum": [ "ACTIVE", "ARCHIVED" ], "example": "ACTIVE", "readOnly": true }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes{/id}" } } } ] }, "hub-search-key": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Search Hub Key HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/keys/00112233445566778899aabb" } } } ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Update index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] }, "delete": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Delete index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] }, "list-replicas": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "List of all the replicas for this index (only returned if replicaCount > 0)", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes?parentId=00112233445566778899aabb{&projection,page,size,sort}" } } } ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/hubs/00112233445566778899aabb" } } } ] }, "settings": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Get the index settings HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/settings" } } } ] }, "update-settings": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Update settings hal link HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/settings{?forwardToReplicas}" } } } ] }, "assigned-content-types": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Assigned Content Type HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types" } } } ] }, "clear": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Clear the index (delete all content) HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/clear" } } } ] }, "stats": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Search index usage statistics hal link HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/stats{?period}" } } } ] }, "top-searches": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Get top searches", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches{?clickAnalytics,orderBy,direction,startDate,endDate,limit,offset,tags,includeReplicas}" } } } ] }, "top-hits": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Get top hits for a search term", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-hits{?search,startDate,endDate,limit,offset,tags,includeReplicas}" } } } ] }, "searches-with-no-results": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Searches with no results HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-with-no-results{?startDate,endDate,limit,offset,tags,includeReplicas}" } } } ] }, "top-filters-no-result-search": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Top filters for a no result search HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-filters-no-result-search{?search,startDate,endDate,limit,offset,tags,includeReplicas}" } } } ] }, "searches-count": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Searches count HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-count{?startDate,endDate,tags,includeReplicas}" } } } ] }, "user-count": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "User count HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/user-count{?startDate,endDate,tags,includeReplicas}" } } } ] }, "no-results-rate": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "No results rate HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/no-results-rate{?startDate,endDate,tags,includeReplicas}" } } } ] }, "archive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Archive index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/archive" } } } ] }, "unarchive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Unarchive index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/unarchive" } } } ] } } } } }, "AlgoliaSearchIndexAnalyticsListSearchesWithNoResults": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "searches-with-no-results": { "type": "array", "items": { "type": "object", "properties": { "search": { "example": "q0" }, "count": { "example": 3 }, "withFilterCount": { "example": 10 } } } } } } } }, { "$ref": "#/components/schemas/HalResponse" }, { "type": "object", "required": [ "_embedded", "_links" ] }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-with-no-results?startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=20" } } } ] }, "searches-with-no-results": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Searches HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-with-no-results{?startDate,endDate,limit,offset,tags}" } } } ] }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First set of results HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-with-no-results?startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=0" } } } ] }, "next": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Next result set HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-with-no-results?startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=30" } } } ] }, "prev": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Previous result set HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-with-no-results?startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=10" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } } ] }, "AlgoliaSearchIndexAnalyticsListTopFiltersNoResultSearch": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "top-filters-no-result-search": { "type": "array", "items": { "type": "object", "properties": { "count": { "example": 3 }, "values": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "example": "brand" }, "operator": { "type": "string", "example": ":", "enum": [ ">", "<", ":" ] }, "value": { "type": "string", "example": "apple" } } } } } } } } } } }, { "$ref": "#/components/schemas/HalResponse" }, { "type": "object", "required": [ "_embedded", "_links" ] }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-filters-no-result-search?search=q0&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=20" } } } ] }, "top-filters-no-result-search": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Top filters for a no result search HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-filters-no-result-search{?search,startDate,endDate,limit,offset,tags}" } } } ] }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First set of results HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-filters-no-result-search?search=q0&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=0" } } } ] }, "next": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Next result set HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-filters-no-result-search?search=q0&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=30" } } } ] }, "prev": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Previous result set HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-filters-no-result-search?search=q0&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=10" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } } ] }, "AlgoliaSearchIndexAnalyticsListTopHits": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "top-hits": { "type": "array", "items": { "type": "object", "properties": { "hit": { "type": "string", "example": "ObjectID" }, "count": { "type": "number", "example": 3 } } } } } } } }, { "$ref": "#/components/schemas/HalResponse" }, { "type": "object", "required": [ "_embedded", "_links" ] }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-hits?search=term&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=20" } } } ] }, "top-hits": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Top hits HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-hits{?search,startDate,endDate,limit,offset,tags}" } } } ] }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First set of results HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-hits?search=term&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=0" } } } ] }, "next": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Next result set HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-hits?search=term&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=30" } } } ] }, "prev": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Previous result set HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-hits?search=term&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=10" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } } ] }, "AlgoliaSearchIndexAnalyticsListTopSearches": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "top-searches": { "type": "array", "items": { "type": "object", "properties": { "search": { "example": "q0" }, "count": { "example": 3 }, "nbHits": { "example": 10 }, "clickThroughRate": { "example": 3 }, "averageClickPosition": { "example": 1 }, "conversionRate": { "example": 0.5 }, "trackedSearchCount": { "example": 2 }, "clickCount": { "example": 2 }, "conversionCount": { "example": 1 } } } } } } } }, { "$ref": "#/components/schemas/HalResponse" }, { "type": "object", "required": [ "_embedded", "_links" ] }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=20" } } } ] }, "top-searches": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Searches HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches{?clickAnalytics,orderBy,direction,startDate,endDate,limit,offset,tags}" } } } ] }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First set of results HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=0" } } } ] }, "next": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Next result set HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=30" } } } ] }, "prev": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Previous result set HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/top-searches?clickAnalytics=false&orderBy=searchCountc&direction=desc&startDate=2020-07-16T00:00:00&endDate=2020-07-23T23:59:59limit=10&offset=10" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } } ] }, "AlgoliaSearchIndexAnalyticsRateOfNoResults": { "type": "object", "properties": { "rate": { "type": "number", "example": 0.5, "description": "The rate at which searches did not return any results", "readOnly": true }, "count": { "type": "number", "example": 10, "description": "Total number of searches for this period", "readOnly": true }, "noResultCount": { "type": "number", "example": 5, "description": "Total number of searches with no results for this period", "readOnly": true }, "dates": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date", "example": "2020-08-24" }, "rate": { "type": "number", "description": "Rate for the given date", "example": 0.5 }, "count": { "type": "number", "description": "Total searches for the given date", "example": 10 }, "noResultCount": { "type": "number", "description": "Total searches with no results for the given date", "example": 5 } } } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/no-results-rate?startDate=2020-08-24&endDate=2020-08-24" } } } ] }, "no-results-rate": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Rate of no results HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/no-results-rate{?startDate,endDate,tags,includeReplicas}" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } }, "AlgoliaSearchIndexAnalyticsSearchesCount": { "type": "object", "properties": { "count": { "type": "number", "example": 3, "description": "Total number of searches for this period", "readOnly": true }, "dates": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date", "example": "2020-08-24" }, "count": { "type": "number", "description": "Count for the given date", "example": 3 } } } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-count?startDate=2020-08-24&endDate=2020-08-24" } } } ] }, "searches-count": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Count of searches HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/analytics/searches-count{?startDate,endDate,tags,includeReplicas}" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } }, "AlgoliaSearchIndexApiKey": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "type": { "description": "Type of key", "type": "string", "enum": [ "HUB_SEARCH" ] }, "key": { "type": "string", "description": "Algolia API key", "example": "AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz" }, "applicationId": { "type": "string", "description": "Algolia application Id", "example": "AaBbCcDdEeFfGg" }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/keys/00112233445566778899aabb" } } } ] } } } } }, "AlgoliaSearchIndexAssignedContentType": { "type": "object", "required": [ "id", "contentTypeUri", "createdDate", "lastModifiedDate", "_links" ], "properties": { "id": { "$ref": "#/components/schemas/Id" }, "contentTypeUri": { "$ref": "#/components/schemas/ContentType" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types/00112233445566778899aabb" } } } ] }, "assigned-content-type": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types{/id}" } } } ] }, "content-type": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content type HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content-types/00112233445566778899aabb" } } } ] }, "unassign": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Unassign this assigned content-type (delete this assigned-content-type)", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types/00112233445566778899aabb" } } } ] }, "webhook": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "DEPRECATED - Please use \"active-content-webhook\" HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/hubs/00112233445566778899aabb/webhook/00112233445566778899aabb" } } } ] }, "recreate-webhook": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "DEPRECATED - Please use \"recreate-active-content-webhook\" HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types/00112233445566778899aabb/recreate-webhook" } } } ] }, "active-content-webhook": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Active content webhook HAL link\n\nThis webhook is responsible for saving your content into your search index when a content item is either published (index type = production) or created/updated (index type = staging).\n", "properties": { "href": { "example": "https://api.amplience.net/v2/hubs/00112233445566778899aabb/webhook/00112233445566778899aabb" } } } ] }, "recreate-active-content-webhook": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Recreate active content webhook HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types/00112233445566778899aabb/recreate-webhook?type=active" } } } ] }, "archived-content-webhook": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Archived content webhook HAL link\n\nThis webhook is responsible for removing your content from your search index when an content item is archived.\n", "properties": { "href": { "example": "https://api.amplience.net/v2/hubs/00112233445566778899aabb/webhook/00112233445566778899aabb" } } } ] }, "recreate-archived-content-webhook": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Recreate archived content webhook HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types/00112233445566778899aabb/recreate-webhook?type=archived" } } } ] } } } } }, "AlgoliaSearchIndexAssignedContentTypeListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "assigned-content-types": { "type": "array", "items": { "$ref": "#/components/schemas/AlgoliaSearchIndexAssignedContentType" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types?page=1&size=20&sort=createdDate,asc" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types?page=0&size=20&sort=createdDate,asc" } } } ] }, "next": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Next page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types?page=2&size=20&sort=createdDate,asc" } } } ] }, "prev": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Previous page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types?page=0&size=20&sort=createdDate,asc" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/assigned-content-types?page=2&size=20&sort=createdDate,asc" } } } ] } } } } } ] }, "AlgoliaSearchIndexListResponseProperties": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "indexes": { "type": "array", "items": { "$ref": "#/components/schemas/AlgoliaSearchIndex" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes?page=1&size=20&sort=indexName,asc" } } } ] }, "indexes": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Indexes HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes{?parentId,projection,page,size,sort}" } } } ] }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes?page=0&size=20&sort=indexName,asc" } } } ] }, "next": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Next page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes?page=2&size=20&sort=indexName,asc" } } } ] }, "prev": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Previous page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes?page=0&size=20&sort=indexName,asc" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes?page=2&size=20&sort=indexName,asc" } } } ] } } } } } ] }, "AlgoliaSearchIndexSettingsProperties": { "type": "object", "properties": { "replicas": { "type": "array", "description": "Index replicas that are managed by Dynamic Content should follow the naming convention <hubName>.<replicaName> - e.g. anyafinn.womens-clothing-replica", "items": { "type": "string" } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/settings" } } } ] }, "settings": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Setting HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/settings" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } }, "AlgoliaSearchIndexStatisticsProperties": { "type": "object", "properties": { "totalRecords": { "type": "number", "description": "The total number of records for the supplied index", "example": 546 }, "totalRecordSize": { "type": "number", "description": "The total size in bytes of the records for the supplied index", "example": 256 }, "averageRecordSize": { "type": "number", "description": "The average size in bytes of the records for the supplied index", "example": 56 }, "usage": { "type": "object", "properties": { "averageResponseTime": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "DAYS" ], "description": "Unit", "example": "DAYS" }, "duration": { "type": "number", "description": "Duration of unit", "example": 30 }, "value": { "type": "number", "description": "The average response time in ms of search queries for the given index (ms)", "example": 1.25 } } }, "numberOfSearches": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "DAYS" ], "description": "Unit", "example": "DAYS" }, "duration": { "type": "number", "description": "Duration of unit", "example": 30 }, "value": { "type": "number", "description": "The total number of searches for the supplied index in the given period", "example": 150 } } } } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/stats" } } } ] }, "stats": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Stats HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/stats{?period}" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } }, "AlgoliaSearchIndexUpdate": { "type": "object", "properties": { "label": { "type": "string", "minLength": 3, "maxLength": 63, "example": "My Index", "description": "User defined index label" } } }, "AlgoliaSearchIndexUserCount": { "type": "object", "properties": { "count": { "type": "number", "description": "The total user count for the supplied index", "example": 3 }, "dates": { "type": "array", "description": "Total user count by day", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "User count date", "example": "2020-01-01" }, "count": { "type": "number", "description": "User count for the given date", "example": 1 } } } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/user-count" } } } ] }, "user-count": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "User count HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb/user-count{?startDate,endDate,tags,includeReplicas}" } } } ] }, "index": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Index HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes/00112233445566778899aabb" } } } ] } } } } }, "BalanceProperties": { "type": "object", "properties": { "metric": { "type": "string", "description": "Name of balance", "example": "dynamic-content-sync-limits", "readOnly": true }, "description": { "type": "string", "description": "Description of the balance", "example": "Number of processed items synced across all hubs in the organisation", "readOnly": true }, "limit": { "type": "string", "description": "Limit for this balance", "example": 1000, "readOnly": true }, "currentUsage": { "type": "string", "description": "Current usage of this balance", "example": 999, "readOnly": true } } }, "BalancesGetResponse": { "type": "object", "required": [ "organisation", "hub", "_links" ], "properties": { "organisation": { "type": "array", "description": "Organisation level balances.", "items": { "$ref": "#/components/schemas/BalanceProperties" } }, "hub": { "type": "array", "description": "Hub level balances.", "items": { "$ref": "#/components/schemas/BalanceProperties" } }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "hub" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/balances" } } } ] }, "balances": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/balances" } } } ] } } } } }, "BatchCreateSnapshotRequest": { "description": "List of snapshot creation requests", "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } }, "BatchCreateSnapshotResponse": { "allOf": [ { "type": "object", "properties": { "hubId": { "$ref": "#/components/schemas/Id" }, "snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } } } }, { "$ref": "#/components/schemas/HalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots/batch" } } }, "snapshots": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Snapshot collection" } ] }, "hub": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" } } } } } } } ] }, "BulkApplyLocaleRequest": { "description": "BulkApplyLocaleProperties", "type": "object", "properties": { "selection": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "version": { "description": "Version of content item", "type": "integer", "example": 1 } } } }, "localization": { "type": "object", "properties": { "locale": { "type": "string", "description": "Locale", "example": "en-gb" } } } } }, "BulkApplyLocaleResponse": { "description": "BulkApplyLocaleResponse", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "type": { "description": "Type of job operation", "type": "string", "example": "LOCALE" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "STARTED", "PARTIAL", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "results": { "properties": { "succeeded": { "type": "array" }, "failed": { "type": "array" } } }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "bulk-apply-locale" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-apply-locale/00112233445566778899bbcc/" } } } ] }, "bulk-apply-locale": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Bulk Apply Locale HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-apply-locale/00112233445566778899bbcc/" } } } ] } } } } }, "BulkApplyLocaleResponseWithResults": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/BulkApplyLocaleResponse" }, { "properties": { "results": { "properties": { "succeeded": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } }, "failed": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "Code": { "description": "Error Code", "type": "string", "example": "NULL_VERSION" }, "message": { "description": "Error message", "type": "string", "example": "version must not be null" } } } } } } } } ] }, "BulkArchiveRequest": { "description": "BulkArchiveProperties", "type": "object", "properties": { "selection": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "version": { "description": "Version of content item to archive", "type": "integer", "example": 1 } } } } } }, "BulkArchiveResponse": { "description": "BulkArchiveResponse", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "type": { "description": "Type of job operation", "type": "string", "example": "ARCHIVE" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "STARTED", "PARTIAL", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "results": { "properties": { "succeeded": { "type": "array" }, "failed": { "type": "array" } } }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "bulk-archive" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-archive/00112233445566778899bbcc/" } } } ] }, "bulk-archive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Bulk Archive HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-archive/00112233445566778899bbcc/" } } } ] } } } } }, "BulkArchiveResponseWithResults": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/BulkArchiveResponse" }, { "properties": { "results": { "properties": { "succeeded": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } }, "failed": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "Code": { "description": "Error Code", "type": "string", "example": "NULL_VERSION" }, "message": { "description": "Error message", "type": "string", "example": "version must not be null" } } } } } } } } ] }, "BulkAssignUsersRequest": { "description": "BulkAssignUsersProperties", "type": "object", "properties": { "selection": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "assignees": { "description": "Array of users to assign to content item", "type": "array", "items": { "type": "string", "example": "00112233445566778899aabb" } } } } } } }, "BulkAssignUsersResponse": { "description": "BulkAssignUserResponse", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "type": { "description": "Type of job operation", "type": "string", "example": "ASSIGN_USERS" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "STARTED", "PARTIAL", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "results": { "properties": { "succeeded": { "type": "array" }, "failed": { "type": "array" } } }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "bulk-assign-users" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-assign-users/00112233445566778899bbcc/" } } } ] }, "bulk-assign-users": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Bulk Assign Users HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-assign-users/00112233445566778899bbcc/" } } } ] } } } } }, "BulkAssignUsersResponseWithResults": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/BulkAssignUsersResponse" }, { "properties": { "results": { "properties": { "succeeded": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } }, "failed": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "Code": { "description": "Error Code", "type": "string", "example": "EMPTY_BULK_JOB_REQUEST" }, "message": { "description": "Error message", "type": "string", "example": "No items were supplied in this request" } } } } } } } } ] }, "BulkCopyItemRequest": { "description": "BulkCopyItemProperties", "type": "object", "properties": { "selection": { "type": "array", "items": { "type": "object", "required": [ "contentItemId", "contentRepositoryId", "label", "name", "version" ], "properties": { "contentItemId": { "description": "Source Content Item ID (used to copy an existing Content Item)", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "version": { "description": "Version of content item to archive", "type": "integer", "example": 1 }, "contentRepositoryId": { "description": "ID of content repo", "type": "string", "example": "00112233-4455-6677-8899-aabbccddaabb" }, "folderId": { "description": "ID of the content folder", "type": "string", "example": "00112233-4455-6677-8899-aabbccddddcc" }, "name": { "type": "string", "example": "New Name" }, "label": { "type": "string", "example": "label1" } } } } } }, "BulkCopyItemResponse": { "description": "BulkCopyItemResponse", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "type": { "description": "Type of job operation", "type": "string", "example": "COPY" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "STARTED", "PARTIAL", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "results": { "properties": { "succeeded": { "type": "array" }, "failed": { "type": "array" } } }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "bulk-copy-item" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-copy-item/00112233445566778899bbcc/" } } } ] }, "bulk-copy-item": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Bulk Copy Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-copy-item/00112233445566778899bbcc/" } } } ] } } } } }, "BulkCopyItemResponseWithResults": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/BulkCopyItemResponse" }, { "properties": { "results": { "properties": { "succeeded": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } }, "failed": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "Code": { "description": "Error Code", "type": "string", "example": "UNAUTHORISED" }, "message": { "description": "Error message", "type": "string", "example": "Authorization required." } } } } } } } } ] }, "BulkPublishRequest": { "description": "BulkPublishProperties", "type": "object", "properties": { "selection": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "version": { "description": "Version of content item to publish", "type": "integer", "example": 1 } } } } } }, "BulkPublishResponse": { "description": "BulkPublishResponse", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "type": { "description": "Type of job operation", "type": "string", "example": "PUBLISH" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "STARTED", "PARTIAL", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "results": { "properties": { "succeeded": { "type": "array" }, "failed": { "type": "array" } } }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "bulk-archive" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-publish-items/00112233445566778899bbcc/" } } } ] }, "bulk-publish-items": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Bulk Publish HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-publish-items/00112233445566778899bbcc/" } } } ] } } } } }, "BulkPublishResponseWithResults": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/BulkPublishResponse" }, { "properties": { "results": { "properties": { "succeeded": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "publishingJobId": { "required": true, "description": "Publishing Job ID", "example": "00112233445566778899aabb" }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "publishing-job": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Publishing Job HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/publishing-jobs/00112233445566778899aabb" } } } ] } } } } } }, "failed": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "Code": { "description": "Error Code", "type": "string", "example": "NULL_VERSION" }, "message": { "description": "Error message", "type": "string", "example": "version must not be null" } } } } } } } } ] }, "BulkUnarchiveRequest": { "description": "BulkUnarchiveProperties", "type": "object", "properties": { "selection": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "version": { "description": "Version of content item to Unarchive", "type": "integer", "example": 1 } } } } } }, "BulkUnarchiveResponse": { "description": "BulkUnarchiveResponse", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "type": { "description": "Type of job operation", "type": "string", "example": "UNARCHIVE" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "STARTED", "PARTIAL", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "results": { "properties": { "succeeded": { "type": "array" }, "failed": { "type": "array" } } }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "bulk-unarchive" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-unarchive/00112233445566778899bbcc/" } } } ] }, "bulk-unarchive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Bulk unarchive HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-unarchive/00112233445566778899bbcc/" } } } ] } } } } }, "BulkUnarchiveResponseWithResults": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/BulkUnarchiveResponse" }, { "properties": { "results": { "properties": { "succeeded": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } }, "failed": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "Code": { "description": "Error Code", "type": "string", "example": "NULL_VERSION" }, "message": { "description": "Error message", "type": "string", "example": "version must not be null" } } } } } } } } ] }, "BulkUpdateWorkflowRequest": { "description": "BulkUpdateWorkflowProperties", "type": "object", "properties": { "selection": { "type": "array", "items": { "type": "object", "properties": { "contentItemId": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "version": { "description": "Version of content item", "type": "integer", "example": 1 } } } }, "workflow": { "type": "object", "properties": { "state": { "type": "string", "description": "Workflow State ID", "example": "00112233445566778899aabb" } } } } }, "BulkUpdateWorkflowResponse": { "description": "BulkUpdateWorkflowResponse", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "type": { "description": "Type of job operation", "type": "string", "example": "UPDATE_WORKFLOW" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "STARTED", "PARTIAL", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "results": { "properties": { "succeeded": { "type": "array" }, "failed": { "type": "array" } } }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "bulk-update-workflow" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-update-workflow/00112233445566778899bbcc/" } } } ] }, "bulk-update-workflow": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Bulk Update Workflow HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-update-workflow/00112233445566778899bbcc/" } } } ] } } } } }, "BulkUpdateWorkflowResponseWithResults": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/BulkUpdateWorkflowResponse" }, { "properties": { "results": { "properties": { "succeeded": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } }, "failed": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of content item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "Code": { "description": "Error Code", "type": "string", "example": "NULL_VERSION" }, "message": { "description": "Error message", "type": "string", "example": "version must not be null" } } } } } } } } ] }, "ContentChange": { "type": "object", "properties": { "property": { "description": "The content item property that has been changed", "type": "string", "example": "_meta/hierarchy/position" }, "previous": { "description": "The previous Hierarchy Node Position", "type": "string", "example": "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~" }, "current": { "description": "The newly set Hierarchy Node Position", "type": "string", "example": "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!" } } }, "ContentItemAssociationsResponse": { "allOf": [ { "type": "object", "properties": { "contentItemId": { "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "associations": { "type": "array", "items": { "properties": { "eventTitle": { "description": "Event Name", "type": "string", "minLength": 1, "maxLength": 120, "example": "Event" }, "eventId": { "$ref": "#/components/schemas/Id" }, "eventStart": { "$ref": "#/components/schemas/Date" }, "eventEnd": { "$ref": "#/components/schemas/Date" }, "editionTitle": { "description": "Edition Name", "type": "string", "minLength": 1, "maxLength": 120, "example": "Edition" }, "editionId": { "$ref": "#/components/schemas/Id" }, "editionStart": { "$ref": "#/components/schemas/Date" }, "editionEnd": { "$ref": "#/components/schemas/Date" }, "editionPubStatus": { "description": "Published Status", "type": "string", "example": "DRAFT", "readOnly": true }, "editionSlotTitle": { "description": "Edition Slot Title", "type": "string", "example": "Slot Label" }, "editionSlotId": { "$ref": "#/components/schemas/Id" }, "editionSlotLocked": { "description": "Edition Slot Locked Status", "type": "boolean", "example": false }, "editionSlotLastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "editionContentTitle": { "description": "Edition Content Title", "type": "string", "example": "Slot Label" }, "editionContentId": { "$ref": "#/components/schemas/Id" }, "editionContentLocked": { "description": "Edition Content Locked Status", "type": "boolean", "example": false }, "editionContentLastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "editionContentMultiRoot\"": { "description": "Edition Content Multiroot Snapshot", "type": "boolean", "example": false }, "snapshotComments": { "description": "Comment", "type": "string", "minLength": 1, "example": "This is a example snapshot." }, "snapshotCreatedBy": { "description": "User who created the Snapshot", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff", "readOnly": true }, "snapshotCreatedDate": { "$ref": "#/components/schemas/CreatedDate" }, "snapshotId": { "$ref": "#/components/schemas/Id" }, "usageCount": { "description": "Usage Count", "type": "number", "example": 1 }, "snapshotLocale": { "description": "Snapshot locale", "type": "string", "readOnly": true, "example": "en-US" }, "contentTypeSchema": { "type": "string", "description": "Content schema", "minLength": 1, "example": "http://example.com/main-banner.json" }, "_links": { "type": "object", "properties": { "get-content": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Edition Slot HAL link", "properties": { "href": { "description": "URL", "type": "string", "format": "url", "example": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb" } } } ] }, "update-content": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Safe Update Content HAL link", "properties": { "href": { "description": "URL", "type": "string", "format": "url", "example": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}" } } } ] }, "get-editionContent": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Edition Content HAL link", "properties": { "href": { "description": "URL", "type": "string", "format": "url", "example": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb" } } } ] }, "update-editionContent": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Update Edition Content HAL link", "properties": { "href": { "description": "URL", "type": "string", "format": "url", "example": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}" } } } ] } } } } } } } }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "edition-slot-associations": { "properties": { "href": { "description": "URL", "type": "string", "format": "url", "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/edition-slot-associations" } } }, "content-item-associations": { "properties": { "href": { "description": "URL", "type": "string", "format": "url", "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/associations" } } } } } } } ] }, "ContentItemContentChange": { "type": "object", "properties": { "contentItemId": { "$ref": "#/components/schemas/UUID" }, "version": { "type": "integer", "description": "Version number (starts at 1)", "readOnly": true, "example": 1 }, "contentChanges": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ContentChange" } ] } } } }, "ContentItemDeliveryKeyProperty": { "type": "object", "properties": { "body": { "type": "object", "example": { "_meta": { "name": "main-banner", "schema": "http://example.com/banner.json", "deliveryKey": "promo-page/main-banner" }, "heading": "Buy more stuff!!", "link": "http://anyafinn.com/buymore?campaign=shouting" }, "required": [ "_meta" ], "properties": { "_meta": { "type": "object", "properties": { "deliveryKey": { "$ref": "#/components/schemas/DeliveryKey" } } } } } } }, "ContentItemFilterResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemRequiredProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] } } } }, "page": { "type": "object", "properties": { "cursor": { "type": "string", "example": "SSBhbSBhIGhhdGNoZWQtZWFzdGVyLWVnZy4gUGxlYXNlIGRvbid0IGRlY29kZSBtZS4=", "description": "cursor for the next page of items (next page may be empty)" }, "count": { "type": "integer", "description": "number of items in the response", "example": 1 } } } } }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233-4455-6677-8899-aabbccddeeff/content-items/filter" } } } } } } } ] }, "ContentItemFindResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-items": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "contentRepositoryId": { "$ref": "#/components/schemas/Id" }, "folderId": { "$ref": "#/components/schemas/Id" }, "deliveryId": { "description": "Delivery ID", "type": "string", "format": "uuid", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "schema": { "description": "Schema", "type": "string", "format": "uri", "example": "http://deliver.bigcontent.io/schema/nested/nested-type.json" }, "version": { "description": "Version", "type": "number", "example": 1 }, "status": { "description": "Status", "type": "string", "example": "ACTIVE" }, "label": { "description": "Label", "type": "string", "example": "Label" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedBy": { "$ref": "#/components/schemas/LastModifiedBy" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "assignees": { "type": "array", "description": "Assignees", "example": [ "00112233445566778899aabb" ] }, "assignedDate": { "description": "Created Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "_links": { "type": "object", "properties": { "publish": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Publish HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish" } } } ] }, "planned": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Planned HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}" } } } ] }, "content-item": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}" } } } ] }, "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" } } } ] } }, "update": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Update HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?ignoreSchemaValidation}" } } } ], "restore-version": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Restore Version HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/restore" } } } ] }, "content-repository": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" } } } ] }, "content-item-version": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item Version HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}" } } } ] }, "content-item-versions": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item Versions HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}" } } } ] }, "copy": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Copy HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "unarchive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Unarchive HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/unarchive" } } } ] }, "archive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Archive HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/archive" } } } ] }, "set-locale": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Set Locale HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/locale" } } } ] }, "create-localizations": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Create Localizations HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localize" } } } ] }, "localizations": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Localizations HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localizations{?page,size,sort}" } } } ] }, "localization-jobs": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Localization Jobs HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff{&page,size,sort}" } } } ] }, "edition-slot-associations": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Edition Slot Associations HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/edition-slot-associations" } } } ] }, "edit-workflow": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Edit Workflow HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/workflow" } } } ] } } } } } } } } } }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233-4455-6677-8899-aabbccddeeff/content-items/find?query=uniondusk&page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233-4455-6677-8899-aabbccddeeff/content-items/find?query=uniondusk&page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233-4455-6677-8899-aabbccddeeff/content-items/find?query=uniondusk&page=0&size=20" } } } ] } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" } ] }, "ContentItemHalLinks": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "content-item": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}" } } } ] }, "planned": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Planned HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}" } } } ] }, "publish": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Publish HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish" } } } ] }, "unpublish": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Unpublish HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/unpublish" } } } ] }, "linked-content": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Linked Content HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}" } } } ] }, "content-item-with-children": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Item With Children HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "content-item-with-parents": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Item With Parents Content HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/search/findByIdWithParents?id=00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Update HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?ignoreSchemaValidation}" } } } ] }, "restore-version": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Restore Version HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/restore" } } } ] }, "content-repository": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" } } } ] }, "content-item-version": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item Version HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}" } } } ] }, "content-item-versions": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item Versions HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}" } } } ] }, "content-item-history": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item Versions HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history{?page,size,sort}" } } } ] }, "copy": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Copy HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "unarchive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Unarchive HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/unarchive" } } } ] }, "archive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Archive HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/archive" } } } ] }, "set-delivery-key": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Set Delivery Key HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/delivery-key" } } } ] }, "set-locale": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Set Locale HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/locale" } } } ] }, "create-localizations": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Create Localizations HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localize" } } } ] }, "localizations": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Localizations HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localizations{?page,size,sort}" } } } ] }, "localization-jobs": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Localization Jobs HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff{&page,size,sort}" } } } ] }, "edition-slot-associations": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Edition Slot Associations HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/edition-slot-associations" } } } ] }, "edit-workflow": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Edit Workflow HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/workflow" } } } ] } } }, "ContentItemListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-items": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ContentItemProperties" }, { "$ref": "#/components/schemas/ContentItemRequiredProperties" }, { "$ref": "#/components/schemas/ContentItemDeliveryKeyProperty" } ] } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20" } } } ] }, "search": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Search HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff/search" } } } ] } } } } } ] }, "ContentItemLocalizationListing": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "locale": { "description": "Locale", "type": "string", "example": "en" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "content-item": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" } } } ] } } } } } } } } } }, { "type": "object", "properties": { "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localizations?page=0&size=20&sort=createdDate,asc" } } } ] }, "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localizations?page=0&size=20&sort=createdDate,asc" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localizations?page=0&size=20&sort=createdDate,asc" } } } ] } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" } ] }, "ContentItemLocalizeRequest": { "type": "object", "required": [ "locales", "version" ], "properties": { "locales": { "type": "array", "description": "List of locales", "example": [ "fr-FR", "de-DE" ] }, "version": { "type": "integer", "description": "Content item version number", "example": 1 }, "replicateFolderStructure": { "type": "boolean", "default": false, "description": "When true, the new localized content items will be placed into the same folder as the origin content item. If localizing across repositories then the folder structure of the origin content item will be replicated in the destination repository for the new localized content items.", "example": true } } }, "ContentItemLocalizeResponse": { "type": "object", "properties": { "status": { "description": "Status", "type": "string", "example": "IN_PROGRESS" }, "rootContentItem": { "type": "object", "properties": { "label": { "description": "Label", "type": "string", "example": "l10n" }, "locale": { "description": "Locale", "type": "string", "example": "en-GB" }, "id": { "type": "string", "readOnly": true, "description": "ID", "example": "00112233-4455-6677-8899-aabbccddeeff" } } }, "requestedLocale": { "description": "Requested Locale", "type": "array", "example": [ "fr-FR", "de-DE" ] }, "replicateFolderStructure": { "type": "boolean", "description": "Replicate Folder Structure", "example": true }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "_links": { "type": "object", "properties": { "content-root": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Root Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "findByRootContentItem": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Find by Root Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff{&page,size,sort}" } } } ] } } } } }, "ContentItemProperties": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "contentRepositoryId": { "$ref": "#/components/schemas/Id" }, "body": { "type": "object", "example": { "_meta": { "name": "main-banner", "schema": "http://example.com/banner.json" }, "heading": "Buy more stuff!!", "link": "http://anyafinn.com/buymore?campaign=shouting" }, "required": [ "_meta" ], "properties": { "_meta": { "type": "object", "required": [ "name", "schema" ], "properties": { "name": { "type": "string", "description": "Schema name", "minLength": 1, "example": "main-banner" }, "schema": { "type": "string", "description": "Content schema", "minLength": 1, "example": "http://example.com/main-banner.json" } } } } }, "label": { "type": "string", "description": "Label", "example": "Banner Ad Homepage", "minLength": 1 }, "folderId": { "type": "string", "description": "Folder ID", "example": "00112233445566778899aabb" }, "assignees": { "type": "array", "description": "Assignees", "example": [ "00112233445566778899aabb" ] }, "assignedDate": { "description": "Created Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "locale": { "type": "string", "description": "Locale", "example": "en-GB" }, "version": { "type": "integer", "description": "Version number (starts at 1)", "readOnly": true, "example": 1 }, "status": { "type": "string", "description": "Status", "enum": [ "ACTIVE", "ARCHIVED", "DELETED" ], "readOnly": true }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedBy": { "$ref": "#/components/schemas/LastModifiedBy" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "lastPublishedDate": { "type": "string", "description": "Last Published Date", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "lastPublishedVersion": { "type": "integer", "description": "Last Published Version", "example": 1, "readOnly": true }, "lastUnpublishedDate": { "type": "string", "description": "Last Unpublished Date", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "lastUnpublishedVersion": { "type": "integer", "description": "Last Unpublished Version", "example": 1, "readOnly": true }, "publishingStatus": { "type": "string", "enum": [ "NONE", "EARLY", "LATEST", "UNPUBLISHED" ], "description": "Publishing Status", "example": "NONE", "readOnly": true }, "deliveryId": { "$ref": "#/components/schemas/UUID" }, "workflow": { "type": "object", "properties": { "state": { "type": "string", "description": "Workflow State ID", "example": "00112233445566778899aabb" } } }, "_links": { "$ref": "#/components/schemas/ContentItemHalLinks" } } }, "ContentItemRequiredProperties": { "required": [ "body", "label" ] }, "ContentItemWithAssigneesProperties": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "contentRepositoryId": { "$ref": "#/components/schemas/Id" }, "body": { "type": "object", "example": { "_meta": { "name": "main-banner", "schema": "http://example.com/banner.json" }, "heading": "Buy more stuff!!", "link": "http://anyafinn.com/buymore?campaign=shouting" }, "required": [ "_meta" ], "properties": { "_meta": { "type": "object", "required": [ "name", "schema" ], "properties": { "name": { "type": "string", "description": "Schema name", "minLength": 1, "example": "main-banner" }, "schema": { "type": "string", "description": "Content schema", "minLength": 1, "example": "http://example.com/main-banner.json" } } } } }, "label": { "type": "string", "description": "Label", "example": "Banner Ad Homepage", "minLength": 1 }, "folderId": { "type": "string", "description": "Folder ID", "example": "00112233445566778899aabb" }, "assignees": { "type": "array", "description": "Assignees", "example": [ "00112233445566778899aabb" ] }, "assignedDate": { "description": "Created Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "locale": { "type": "string", "description": "Locale", "example": "en-GB" }, "version": { "type": "integer", "description": "Version number (starts at 1)", "readOnly": true, "example": 1 }, "status": { "type": "string", "description": "Status", "enum": [ "ACTIVE", "ARCHIVED", "DELETED" ], "readOnly": true }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedBy": { "$ref": "#/components/schemas/LastModifiedBy" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "deliveryId": { "$ref": "#/components/schemas/UUID" }, "_links": { "$ref": "#/components/schemas/ContentItemHalLinks" } } }, "ContentRepositoryListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-repositories": { "type": "array", "items": { "$ref": "#/components/schemas/ContentRepositoryProperties" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-repositories?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-repositories?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-repositories?page=0&size=20" } } } ] } } } } } ] }, "ContentRepositoryListResponseWithSearch": { "allOf": [ { "$ref": "#/components/schemas/ContentRepositoryListResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "search:findByFeaturesContaining": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Find by features HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/search/findByFeaturesContaining?feature={feature}{&page,size,sort}" } } } ] } } } } } ] }, "ContentRepositoryProperties": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "name": { "description": "Name", "type": "string", "minLength": 1, "example": "inspiration" }, "label": { "description": "Name", "type": "string", "minLength": 1, "example": "inspiration" }, "status": { "description": "Status (defaults to ACTIVE)", "readOnly": true, "type": "string", "enum": [ "ACTIVE", "DELETED" ], "example": "ACTIVE" }, "features": { "description": "Features", "readOnly": true, "type": "array", "items": { "type": "string", "example": "slots" } }, "type": { "description": "Repository Type", "readOnly": true, "type": "string", "enum": [ "CONTENT" ] }, "contentTypes": { "description": "Content types", "readOnly": true, "type": "array", "items": { "type": "object", "properties": { "hubContentTypeId": { "type": "string", "description": "Content type Id", "example": "00112233445566778899aabb" }, "contentTypeUri": { "type": "string", "description": "Content type URI", "example": "http://example.com/content-type.json" } } } }, "itemLocales": { "description": "Locales", "readOnly": true, "type": "array", "items": { "type": "string", "description": "Locale", "example": "en_US" } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" } } } ] }, "content-repository": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" } } } ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Update this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" } } } ] }, "delete": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Delete this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" } } } ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" } } } ] }, "create-content-item": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Create Content Items within this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items{?ignoreSchemaValidation}" } } } ] }, "search-content-items": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Search for Content Item(s) HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-items/find{?page,projection,query,size,sort}" } } } ] }, "facet-content-items": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Facet for Content Item(s) HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-items/facet{?page,projection,query,size,sort}" } } } ] }, "content-items": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "List all of the Content Items within this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items{?folderId,page,projection,size,sort,status}" } } } ] }, "share": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Share this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/share" } } } ] }, "assign-content-type": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Assign Content Types to this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-types" } } } ] }, "unassign-content-type": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Unassign Content Types to this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-types/{id}" } } } ] }, "folders": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "List all of the folders for this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/folders{?page,size,sort}" } } } ] }, "create-folder": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Create a folder for this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/folders" } } } ] }, "features": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Update a feature for this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/features?feature={feature}" } } } ] }, "update-content-items": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Update Content Items HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items" } } } ] }, "set-item-locales": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Manage the Content Item locales for this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/item-locales" } } } ] }, "join-localization-group": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Manage the localization groups for this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/localization-group" } } } ] }, "localization-group-locales": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Manage the localization groups locales for this Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/localization-group/locales" } } } ] } } } } }, "ContentRepositoryRequiredProperties": { "type": "object", "required": [ "name", "label" ] }, "ContentType": { "type": "string", "description": "Registered Content Type Schema", "example": "http://deliver.bigcontent.io/schema/banner-type.json" }, "ContentTypeListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-types": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeProperties" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-type/00112233445566778899aabb?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-type/00112233445566778899aabb?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-type/00112233445566778899aabb?page=0&size=20" } } } ] } } } } } ] }, "ContentTypeProperties": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "contentTypeUri": { "type": "string", "description": "Content Type URI", "example": "http://example.com/content-type.json", "minLength": 1, "readOnly": true }, "status": { "type": "string", "description": "Status", "enum": [ "ACTIVE", "ARCHIVED" ], "example": "ACTIVE", "readOnly": true }, "settings": { "type": "object", "properties": { "label": { "type": "string", "description": "Label", "minLength": 1, "example": "New Content Type" }, "icons": { "type": "array", "description": "Icons", "items": { "type": "object", "properties": { "size": { "type": "integer", "description": "Icon size", "example": 256 }, "url": { "type": "string", "description": "Icon URL", "example": "http://example.com/icon.png", "minLength": 1 } } } }, "visualizations": { "type": "array", "description": "Visualizations", "items": { "type": "object", "required": [ "label", "templatedUri", "default" ], "properties": { "label": { "type": "string", "description": "Visualization Label", "example": "Desktop Website" }, "templatedUri": { "type": "string", "description": "Visualization templated URI", "example": "http://example.com?vse={{vse}}" }, "default": { "type": "boolean", "description": "Default visualization", "example": true } } } } } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb" } } } ] }, "archive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Archive self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/archive" } } } ] }, "unarchive": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Unarchive self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/unarchive" } } } ] }, "content-type": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Type HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb" } } } ] }, "effective-content-type": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Effective Content Type HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/effective-content-type" } } } ] }, "content-type-schema": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Type Schema HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/schema" } } } ] } } } } }, "ContentTypeRequiredProperties": { "type": "object", "required": [ "settings" ], "properties": { "settings": { "type": "object", "required": [ "label" ], "properties": { "icons": { "type": "array", "items": { "type": "object", "required": [ "size", "url" ] } }, "visualizations": { "type": "array", "items": { "type": "object", "required": [ "label", "templatedUri", "default" ] } } } } } }, "CreatedBy": { "description": "Created by User Id", "type": "string", "format": "uuid", "example": "00112233-4455-6677-8899-aabbccddeeff", "readOnly": true }, "CreatedDate": { "description": "Created Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "Date": { "description": "Date/Time", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "DeliveryKey": { "description": "Delivery key", "type": "string", "minLength": 1, "maxLength": 150, "pattern": "^(?!.*[/]{2})[A-Za-z0-9-_]+[A-Za-z0-9-_/]*(??hubId=00112233445566778899aabb?page=0&size=20" } } } ] }, "list-integrations": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "List the integrations of this type HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/?hubId=00112233445566778899aabb?page=0&size=20" } } } ] }, "create-integrations": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Create a new integration of this type HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/?hubId=00112233445566778899aabb?page=0&size=20" } } } ] } } } } }, "ItemLocales": { "type": "object", "required": [ "itemLocales" ], "properties": { "itemLocales": { "type": "array", "description": "Item locales", "example": [ "en", "fr" ], "items": { "type": "string", "description": "locale" } } } }, "JobCreateDeepSyncRequest": { "type": "object", "properties": { "label": { "description": "Job label", "type": "string", "example": "deep sync job" }, "ignoreSchemaValidation": { "type": "boolean", "description": "Ignore schema validation" }, "destinationHubId": { "type": "string", "description": "Hub ID", "example": "00112233445566778899aabb" }, "input": { "type": "object", "description": "job request input data", "properties": { "rootContentItemIds": { "type": "string", "description": "root contentItemIds", "example": [ "00112233-4455-6677-8899-aabbccddeeff" ] } } } } }, "JobCreateDeepSyncResponse": { "type": "object", "properties": { "jobId": { "$ref": "#/components/schemas/Id" }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/jobs/00112233445566778899aabb" } } } ] }, "job": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Jobs HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/jobs/{id}" } } } ] } } } } }, "JobErrors": { "description": "Job errors", "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "object", "properties": { "entityId": { "type": "String", "$ref": "#/components/schemas/UUID" }, "entityType": { "type": "string", "example": "Hub" } } }, "errorResponse": { "type": "object", "properties": { "code": { "description": "Status", "type": "string", "example": "SUCCESS" }, "level": { "description": "Level", "type": "string", "enum": [ "INFO", "WARNING", "ERROR", "FATAL" ], "example": "INFO" }, "message": { "description": "Message", "type": "string", "example": null } } } } } }, "JobGetResponse": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "label": { "description": "Job label", "type": "string", "minLength": 1, "example": "Anya Finn" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "IN_PROGRESS", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "stateChanges": { "$ref": "#/components/schemas/JobStateChanges" }, "jobType": { "description": "Type of Job", "type": "string", "enum": [ "DEEP_SYNC_JOB" ], "example": "DEEP_SYNC_JOB", "readOnly": true }, "originHubId": { "$ref": "#/components/schemas/Id" }, "destinationHubId": { "$ref": "#/components/schemas/Id" }, "rootContentItemIDs": { "type": "array", "items": { "type": "string", "example": "00112233445566778899aabb" } }, "associatedHubIds": { "type": "array", "items": { "type": "string", "example": "00112233445566778899aabb, 00112233445566778899aabb" } }, "errors": { "$ref": "#/components/schemas/JobErrors" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "hub" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/jobs/00112233445566778899aabb" } } } ] }, "job": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/jobs/00112233445566778899aabb" } } } ] } } } } }, "JobListProperties": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "label": { "description": "Hub label", "type": "string", "minLength": 1, "example": "Anya Finn" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "IN_PROGRESS", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "stateChanges": { "$ref": "#/components/schemas/JobStateChanges" }, "jobType": { "description": "Type of Job", "type": "string", "enum": [ "DEEP_SYNC_JOB" ], "example": "DEEP_SYNC_JOB", "readOnly": true }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "_links": { "type": "object", "readOnly": true, "description": "Resource HAL links", "required": [ "self", "hub" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/jobs/00112233445566778899aabb" } } } ] }, "job": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/jobs/{id}" } } } ] } } } } }, "JobListRequest": { "type": "object", "properties": { "user": { "description": "User Id", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "limitDateRange": { "type": "boolean", "description": "Limit the listed jobs to the last 30 days" }, "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "IN_PROGRESS", "FAILED", "COMPLETED" ], "example": "CREATED" }, "jobType": { "description": "Status of Job", "type": "string", "enum": [ "DEEP_SYNC_JOB" ], "example": "DEEP_SYNC_JOB" } } }, "JobListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/JobListProperties" } ] } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233-4455-6677-8899-aabbccddeeff/jobs?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233-4455-6677-8899-aabbccddeeff/jobs?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233-4455-6677-8899-aabbccddeeff/jobs?page=0&size=20" } } } ] } } } } } ] }, "JobStateChanges": { "description": "Job state changes", "type": "array", "items": { "type": "object", "properties": { "status": { "description": "Status of Job", "type": "string", "enum": [ "CREATED", "IN_PROGRESS", "FAILED", "COMPLETED" ] }, "timestamp": { "$ref": "#/components/schemas/Date" } } } }, "JsonPath": { "type": "object", "description": "JSON path notation for a value to replace", "required": [ "jsonPath" ], "properties": { "jsonPath": { "type": "string", "example": "$.body.field" }, "fallback": { "type": "string", "example": "fallback value" } } }, "LastModifiedBy": { "description": "Last Modified by User Id", "type": "string", "format": "uuid", "example": "00112233-4455-6677-8899-aabbccddeeff", "readOnly": true }, "LastModifiedDate": { "description": "Last Modified Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "LinkedContentRepositoriesRequest": { "type": "object", "properties": { "originHubId": { "description": "Defines the hub id to use as a starting point for unidirectional relationships", "type": "string", "example": "00112233445566778899aabb" }, "hubIds": { "type": "array", "example": [ "00112233445566778899aabb", "00112233445566778899ccdd" ] }, "bidirectional": { "description": "Defines the directionality of the linked repositories", "type": "boolean", "example": false }, "relationships": { "type": "array", "items": { "properties": { "originRepositoryId": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "dstRepositoryId": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } } } }, "LinkedContentRepositoriesResponse": { "type": "object", "properties": { "originHubId": { "description": "Hub ID", "type": "string", "example": "00112233445566778899aabb" }, "hubIds": { "type": "array", "example": [ "00112233445566778899aabb", "00112233445566778899ccdd" ] }, "bidirectional": { "description": "Defines the directionality of the linked content repositories", "type": "boolean", "example": false }, "relationships": { "type": "array", "items": { "properties": { "originRepositoryId": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "dstRepositoryId": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "required": "self", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hub/00112233445566778899aabb/linked-content-repositories" } } } ] }, "linked-content-repositories": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hub/00112233445566778899aabb/linked-content-repositories" } } } ] } } } } }, "ListContentItemHistoryResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-item-history": { "type": "array", "items": { "properties": { "summary": { "type": "array", "items": { "properties": { "action": { "description": "Action", "type": "object", "properties": { "code": { "description": "Code", "type": "string", "example": "UPDATED" }, "data": { "description": "Data", "type": "object" } } }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "historyEventId": { "$ref": "#/components/schemas/UUID" } } } }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "version": { "description": "Version", "type": "number", "example": 1 }, "_links": { "type": "object", "properties": { "content-item-version": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Item Version HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1" } } } ] }, "content-item-version-history": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Item Version History HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history{?page,sort,size}" } } } ] } } } } } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history?page=0&size=20" } } } ] } } } } } ] }, "ListContentItemHistoryVersion": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-item-version-history": { "type": "array", "items": { "properties": { "historyEventId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/Id" }, "version": { "description": "Version", "type": "number", "example": 1 }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "action": { "description": "Action", "type": "object", "properties": { "code": { "description": "Code", "type": "string", "example": "CREATED" }, "data": { "description": "Data", "type": "object" } } } } } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history?page=0&size=20" } } } ] } } } } } ] }, "ListContentItemVersions": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "content-items": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "contentRepositoryId": { "$ref": "#/components/schemas/Id" }, "folderId": { "$ref": "#/components/schemas/Id" }, "body": { "type": "object", "properties": { "_meta": { "type": "object", "properties": { "name": { "description": "Name", "type": "string", "example": "Main-Banner" }, "schema": { "description": "Schema", "type": "string", "format": "uri", "example": "http://deliver.bigcontent.io/schema/nested/nested-type.json" }, "deliveryKey": { "$ref": "#/components/schemas/DeliveryKey" } } } } }, "heading": { "description": "Heading", "type": "string", "example": "Main-Banner" }, "link": { "description": "Link", "type": "string", "format": "uri", "example": "http://anyafinn.com/buymore?campaign=shouting" } } } }, "version": { "description": "Version", "type": "number", "example": 1 }, "label": { "description": "Label", "type": "string", "example": "Label" }, "status": { "description": "Status", "type": "string", "example": "ACTIVE" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedBy": { "$ref": "#/components/schemas/LastModifiedBy" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "assignees": { "type": "array", "description": "Assignees", "example": [ "00112233445566778899aabb" ] }, "assignedDate": { "description": "Created Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "deliveryId": { "description": "Delivery ID", "type": "string", "format": "uuid", "example": "00112233-4455-6677-8899-aabbccddeeff" } } }, "_links": { "type": "object", "properties": { "planned": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Planned HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}" } } } ] }, "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1" } } } ] }, "content-item-version-history": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item Version History HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history{?page,size,sort}" } } } ] }, "content-item": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}" } } } ] }, "content-item-version": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item Version HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}" } } } ] }, "content-item-versions": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Content Item Versions HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}" } } } ] }, "content-repository": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Repository HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" } } } ] }, "content-item-with-children": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Item with Children HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "content-item-with-parents": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content Item With Parents HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/search/findByIdWithParents?id=00112233-4455-6677-8899-aabbccddeeff" } } } ] } } } } }, "ListLinkedContentRepositoriesResponse": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "linked-content-repositories": { "type": "array", "items": { "type": "object", "properties": { "originHubId": { "description": "Hub ID", "type": "string", "example": "00112233445566778899aabb" }, "hubIds": { "type": "array", "example": [ "00112233445566778899aabb", "00112233445566778899ccdd" ] }, "originHubLabel": { "description": "Origin Hub label", "type": "string", "minLength": 1, "example": "Anya Finn" }, "destinationHubLabel": { "description": "Destination Hub label", "type": "string", "minLength": 1, "example": "Anya Finn" }, "bidirectional": { "description": "Defines the directionality of the linked content repositories", "type": "boolean", "example": false }, "relationships": { "type": "array", "items": { "properties": { "originRepositoryId": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "originRepositoryLabel": { "description": "Name", "type": "string", "minLength": 1, "example": "inspiration" }, "dstRepositoryId": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "dstRepositoryLabel": { "description": "Name", "type": "string", "minLength": 1, "example": "inspiration" } } } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "required": "self", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hub/00112233445566778899aabb/linked-content-repositories" } } } ] }, "linked-content-repositories": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hub/00112233445566778899aabb/linked-content-repositories" } } } ] } } } } } } } } } }, "LocaleLabels": { "type": "object", "required": [ "locale", "label" ], "properties": { "locale": { "description": "locale", "type": "string", "minLength": 1, "example": "en-gb" }, "label": { "description": "label", "type": "string", "maxLength": 12, "example": "england" } } }, "LocalizationGroup": { "type": "object", "required": [ "newRepositoryId" ], "properties": { "newRepositoryId": { "description": "New Content Repository ID", "type": "string", "example": "00112233445566778899aabb" } } }, "LocalizationGroupLocales": { "type": "object", "properties": { "locales": { "type": "array", "description": "Item locales", "example": [ "en", "fr" ], "items": { "type": "string", "description": "locale" } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/localization-group/locales" } } } ] } } } } }, "LocalizationJobs": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "localization-jobs": { "type": "array", "items": { "properties": { "status": { "description": "Status", "type": "string", "example": "IN_PROGRESS" }, "rootContentItem": { "type": "object", "properties": { "label": { "description": "Label", "type": "string", "example": "l10n" }, "locale": { "description": "Locale", "type": "string", "example": "en-GB" }, "id": { "type": "string", "readOnly": true, "description": "ID", "example": "00112233-4455-6677-8899-aabbccddeeff" } } }, "requestedLocale": { "description": "Requested Locale", "type": "array", "example": [ "fr-FR", "de-DE" ] }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "_links": { "type": "object", "properties": { "content-root": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Root Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "findByRootContentItem": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Find by Root Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff{&page,size,sort}" } } } ] } } } } } } } } } }, { "type": "object", "properties": { "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff?page=0&size=20" } } } ] }, "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last Content Item HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff?page=0&size=20" } } } ] }, "search-localization-jobs": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Search Localization Jobs HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/localization-jobs/search" } } } ] } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" } ] }, "LocationHeader": { "type": "string", "description": "URL of the Entity", "format": "uri" }, "ManageLocaleLabelsRequest": { "type": "object", "properties": { "localeLabels": { "type": "array", "description": "An Array of objects containing a Locale and Label property", "items": { "$ref": "#/components/schemas/LocaleLabels" } } } }, "ManageLocaleLabelsResponse": { "type": "object", "properties": { "localeLabels": { "type": "array", "description": "An Array of objects containing a Locale and Label property", "items": { "$ref": "#/components/schemas/LocaleLabels" } }, "_links": { "type": "object", "description": "Resource HAL links", "required": [ "self", "manage", "locale-labels", "hub" ], "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/locale-labels" } } }, "local-labels": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/locale-labels" } } }, "manage": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/locale-labels" } } }, "hub": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" } } } } } } }, "Member": { "type": "object", "properties": { "sid": { "description": "Member id", "type": "string", "example": "alice" }, "permissions": { "description": "List of permissions", "type": "array", "minLength": 1, "example": [ "READ", "EDIT", "DELETE", "SHARE", "CREATE_REPOSITORY", "CREATE_EVENT", "EDIT_EVENT", "DELETE_EVENT", "CREATE_EDITION", "EDIT_EDITION", "DELETE_EDITION", "MANAGE_ACCESS", "EDIT_WORKFLOW_STATES" ] }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "type": "object", "description": "Self HAL link", "properties": { "href": { "description": "URL", "type": "string", "format": "url", "example": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/alice" } } }, "revoke-permission": { "type": "object", "description": "Delete Member's Permission(s) HAL link", "properties": { "href": { "description": "URL", "type": "string", "format": "url", "example": "https://api.amplience.net/v2/content/admin/access/hubs/00112233445566778899aabb/members/alice" }, "templated": { "description": "Indicates that href is templated", "type": "boolean", "example": true } } } } } } }, "PaginatedHalResponse": { "allOf": [ { "$ref": "#/components/schemas/HalResponse" }, { "type": "object", "readOnly": true, "properties": { "page": { "type": "object", "readOnly": true, "required": [ "size", "totalElements", "totalPages", "number" ], "properties": { "size": { "description": "Current page size", "type": "integer", "minimum": 1, "maximum": 100, "example": 20 }, "totalElements": { "description": "Total number of resources", "type": "integer", "minimum": 1, "example": 1 }, "totalPages": { "description": "Total number of pages", "type": "integer", "minimum": 1, "example": 1 }, "number": { "description": "Page number", "type": "integer", "minimum": 0, "example": 0 } } } } }, { "type": "object", "required": [ "_embedded", "_links", "page" ] } ] }, "PublishHierarchies": { "type": "array", "items": { "type": "object", "properties": { "hierarchyNodeIds": { "description": "ID's", "type": "array", "example": [ "00112233-4455-6677-8899-aabbccddeeff" ] }, "getDescendants": { "type": "boolean", "example": false } } } }, "PublishingJob": { "type": "object", "required": [ "id", "scheduledDate", "createdDate", "createdBy", "state", "_links" ], "properties": { "id": { "$ref": "#/components/schemas/Id" }, "scheduledDate": { "description": "Scheduled date & time for Publishing Job", "type": "string", "example": "2018-01-01T00:00:00Z", "writeOnly": true }, "createdDate": { "description": "Date Publishing Job was created", "type": "string", "example": "2018-01-01T00:00:00Z", "readOnly": true }, "createdBy": { "description": "User who created the Publishing Job", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff", "readOnly": true }, "state": { "description": "State of Publishing Job", "type": "string", "enum": [ "CREATED", "CANCELLED", "PREPARING", "WAITING", "PUBLISHING", "FAILED", "COMPLETED" ], "example": "CREATED", "readOnly": true }, "publishErrorStatus": { "description": "Publish error status (only present if `state=FAILED`)", "type": "string", "readOnly": true }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "required": [ "self", "publishing-job", "snapshot" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/publishing-jobs/00112233445566778899aabb" } } } ] }, "publishing-job": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Publishing Job HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/publishing-jobs/00112233445566778899aabb" } } } ] }, "snapshot": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Snapshot HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb" } } } ] }, "cancel": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Cancel Publishing Job HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/publishing-jobs/00112233445566778899aabb" } } } ] } } } } }, "PublishingJobListResponse": { "allOf": [ { "type": "object", "required": [ "_embedded" ], "properties": { "_embedded": { "type": "object", "required": [ "publishing-jobs" ], "properties": { "publishing-jobs": { "type": "array", "items": { "$ref": "#/components/schemas/PublishingJob" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "required": [ "_links" ], "properties": { "_links": { "type": "object", "required": [ "self", "first", "last" ], "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/publishing-jobs/00112233445566778899aabb?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/publishing-jobs/00112233445566778899aabb?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/publishing-jobs/00112233445566778899aabb?page=0&size=20" } } } ] } } } } } ] }, "ResolveEditionConflicts": { "type": "object", "required": [ "lastModifedDate", "resolutions" ], "properties": { "comment": { "description": "Comment", "type": "string", "example": "Comment" }, "lastModifiedDate": { "description": "Last Modified Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z" }, "resolutions": { "type": "array", "items": { "type": "object", "required": [ "contentItemId", "version" ], "properties": { "contentItemId": { "description": "ID", "type": "string", "example": "00112233445566778899aabb" }, "version": { "description": "Version", "type": "number", "minimum": 1, "example": 1 } } } } } }, "RestoreContentByVersionResponse": { "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "contentRepositoryId": { "$ref": "#/components/schemas/Id" }, "folderId": { "$ref": "#/components/schemas/Id" }, "body": { "type": "object", "properties": { "_meta": { "type": "object", "properties": { "name": { "description": "Name", "type": "string", "example": "Name" }, "schema": { "description": "Schema", "type": "string", "format": "uri", "example": "http://deliver.bigcontent.io/schema/nested/nested-type.json" }, "deliveryKey": { "$ref": "#/components/schemas/DeliveryKey" } } }, "heading": { "description": "heading", "type": "string", "example": "Heading" }, "link": { "description": "Link", "type": "string", "format": "uri", "example": "http://anyafinn.com/buymore?campaign=shouting" } } }, "assignees": { "type": "array", "description": "Assignees", "example": [ "00112233445566778899aabb" ] }, "assignedDate": { "description": "Created Date", "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00.000Z", "readOnly": true }, "version": { "description": "Version", "type": "number", "example": 1 }, "label": { "description": "Label", "type": "string", "example": "Label" }, "status": { "description": "Status", "type": "string", "example": "ACTIVE" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedBy": { "$ref": "#/components/schemas/LastModifiedBy" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "deliveryId": { "description": "Delivery ID", "type": "string", "format": "uuid", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "_links": { "$ref": "#/components/schemas/ContentItemHalLinks" } } }, "SearchEditionsResponse": { "type": "object", "required": [ "_links" ], "properties": { "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "required": [ "self", "findOneByPublishManifestId", "findByEvent", "findOneByPublishingJobId" ], "properties": { "findOneByPublishManifestId": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Find By Publish Manifest Id HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/editions/search/findOneByPublishManifestId" } } } ] }, "findByEvent": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Find By Event HAL Link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=00112233445566778899aabb{&page,size,sort}" } } } ] }, "findOneByPublishingJobId": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Find By Publishing Job Id HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/editions/search/findOneByPublishingJobId" } } } ] }, "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" } } } ] } } } } }, "SfccIntegrationListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/SfccIntegrationProperties" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfcc?hubId=00112233445566778899aabb&cursor=page=0&size=20&sort=label,asc" } } } ] }, "integrations": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "SFCC Integrations HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfcc{?hubId,cursor,page,size,sort}" } } } ] } } } } } ] }, "SfccIntegrationProperties": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "ID", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "label": { "type": "string", "example": "Salesforce Commerce Cloud" }, "hubId": { "description": "Hub ID", "type": "string", "readOnly": true, "example": "00112233445566778899aabb" }, "sfcc-credentials": { "type": "object", "description": "Credentials for integrating with SFCC", "required": [ "id", "secret" ], "properties": { "id": { "type": "string", "maxLength": 64, "example": "SFCC_ID" }, "secret": { "type": "string", "writeOnly": true, "maxLength": 64, "example": "SFCC_SECRET" } } }, "dc-credentials": { "type": "object", "description": "Credentials for integrating with DC", "required": [ "id", "secret" ], "properties": { "id": { "type": "string", "maxLength": 64, "example": "DC_ID" }, "secret": { "type": "string", "writeOnly": true, "maxLength": 64, "example": "DC_SECRET" } } }, "sfcc-api": { "type": "object", "description": "Details to use when communicating with SFCC", "required": [ "path", "version" ], "properties": { "path": { "type": "string", "maxLength": 1000, "description": "API endpoint", "example": "https://example.com" }, "version": { "type": "string", "description": "SFCC API version to use", "example": "v18_10" } } }, "contentSlots": { "type": "object", "properties": { "site": { "type": "string", "description": "This is the site id that you wish to publish content to. Slots in SFCC are site specific.", "example": "mySite" }, "ismlTemplate": { "type": "string", "maxLength": 256, "description": "This is a template in your storefront cartridge that is used for slots of type HTML", "example": "slots/html/htmlslotcontainer.isml" } } }, "rendering": { "type": "object", "description": "Used for setting up content previews", "required": [ "vseDomain", "htmlTemplate" ], "properties": { "vseDomain": { "type": "string", "maxLength": 1000, "description": "Preview staging environment", "example": "00112233445566778899aabb.staging.bigcontent.io" }, "htmlTemplate": { "type": "string", "maxLength": 256, "description": "HTML template to preview the content with", "example": "sfcc" } } }, "contentAssets": { "type": "object", "description": "Filtering settings defining which content items are sent to SFCC", "required": [ "library", "contentTypes" ], "properties": { "library": { "type": "string", "description": "Which SFCC content library to use", "example": "default" }, "contentRepository": { "type": "string", "description": "Which DC content repository to use", "example": "00112233445566778899aabb" }, "contentTypes": { "type": "array", "minItems": 1, "maxItems": 40, "maxLength": 1000, "description": "The content types to send to SFCC", "items": { "type": "object", "properties": { "contentType": { "$ref": "#/components/schemas/ContentType" }, "folders": { "type": "array", "required": [ "id" ], "description": "Folders within SFCC to assign content to. Folders that do not exist already will be created.", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.sfcc_id" } } } ] }, { "type": "string", "description": "The name of the folder to use", "example": "folderId" } ] }, "default": { "type": "boolean", "description": "Should this be the default folder to be used for all content", "example": false }, "optional": { "type": "boolean", "description": "This folder is optional, if the \"id\" does not exist it will not be assigned", "example": false } } } }, "mappings": { "type": "object", "required": [ "id" ], "description": "Mapped values to use when creating the SFCC content", "properties": { "id": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.sfcc_id" } } } ] }, "name": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.name" } } } ] }, "onlineFlag": { "type": "object", "description": "SFCC site-specific property", "properties": { "default": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.online" } } } ] }, "mySite": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.site" } } } ] } } }, "description": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.description" } } } ] }, "siteMapPriority": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.siteMapPriority" } } } ] }, "defaultedBoolean": { "type": "object", "description": "SFCC site-specific property", "properties": { "default": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.defaultedBoolean" } } } ] }, "mySite": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.site_boolean" } } } ] } } }, "defaultedNumber": { "type": "object", "description": "SFCC site-specific property", "properties": { "default": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.defaultedNumber" } } } ] }, "mySite": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.site_number" } } } ] } } }, "defaultedObject": { "type": "object", "description": "SFCC site-specific property", "properties": { "default": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.defaultedObject" } } } ] }, "mySite": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.site_object" } } } ] } } }, "boolean_field": { "allOf": [ { "$ref": "#/components/schemas/JsonPath" }, { "type": "object", "properties": { "jsonPath": { "example": "$.body.boolean_field" } } } ] } } } } } } } }, "localeMappings": { "type": "object", "description": "Locales to use when creating SFCC content, any valid locale can be used", "example": { "default": "*", "fr-FR": "fr-FR,en,*", "de": "de-*,en-*,*" } }, "lastInvocationTimestamp": { "allOf": [ { "description": "Will always be returned, however can be a null value" }, { "$ref": "#/components/schemas/Date" } ] }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "webhook": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Webhook HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff/webhook" } } } ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Webhook HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "delete": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Webhook HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "webhook-subscription": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Webhook Subscription HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb" } } } ] } } } } }, "SfccIntegrationRequiredProperties": { "required": [ "id", "hubId", "dc-credentials", "sfcc-credentials", "sfcc-api", "rendering", "_links" ] }, "SfmcIntegrationListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/SfmcIntegrationProperties" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfmc?hubId=00112233445566778899aabb&cursor=page=0&size=20&sort=label,asc" } } } ] }, "integrations": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "SFMC Integrations HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfmc{?hubId,cursor,page,size,sort}" } } } ] } } } } } ] }, "SfmcIntegrationProperties": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "ID", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "label": { "type": "string", "maxLength": 120, "example": "Salesforce Marketing Cloud" }, "active": { "type": "boolean", "example": true }, "hubId": { "description": "Hub ID", "type": "string", "maxLength": 64, "readOnly": true, "example": "00112233445566778899aabb" }, "sfmc-credentials": { "type": "object", "description": "Credentials for integrating with SFMC", "required": [ "id", "secret" ], "properties": { "id": { "type": "string", "maxLength": 64, "example": "SFMC_ID" }, "secret": { "type": "string", "writeOnly": true, "maxLength": 64, "example": "SFMC_SECRET" }, "authDomain": { "type": "string", "maxLength": 1000, "example": "SFMC_SECRET" } } }, "dc-credentials": { "type": "object", "description": "Credentials for integrating with DC", "required": [ "id", "secret" ], "properties": { "id": { "type": "string", "maxLength": 64, "example": "DC_ID" }, "secret": { "type": "string", "writeOnly": true, "maxLength": 64, "example": "DC_SECRET" } } }, "rendering": { "type": "object", "description": "Used for setting up content previews", "required": [ "vseDomain" ], "properties": { "vseDomain": { "type": "string", "maxLength": 1000, "description": "Preview staging environment", "example": "00112233445566778899aabb.staging.bigcontent.io" } } }, "contentAssets": { "type": "object", "description": "Settings to use when creating SFMC content", "required": [ "topLevelFolder", "contentTypeSchemas" ], "properties": { "topLevelFolder": { "type": "string", "description": "Which SFMC folder to use", "example": "myFolder" }, "contentTypeSchemas": { "type": "array", "minItems": 1, "maxItems": 40, "description": "The Content Type Schemas to use when generating content for SFMC", "items": { "type": "object", "required": [ "id", "htmlTemplate" ], "properties": { "id": { "allOf": [ { "$ref": "#/components/schemas/ContentType" }, { "minLength": 1, "maxLength": 500 } ] }, "htmlTemplate": { "type": "string", "minLength": 1, "maxLength": 256, "description": "The HTML template used to generate content", "example": "sfmc" } } } } } }, "lastInvocationTimestamp": { "type": "integer", "readOnly": true, "example": 1234567890 }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" } } } ] }, "webhook": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Webhook HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff/webhook" } } } ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Webhook HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "delete": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Webhook HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff" } } } ] }, "webhook-subscription": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Webhook Subscription HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb" } } } ] } } } } }, "SfmcIntegrationRequiredProperties": { "required": [ "label", "active", "hubId", "dc-credentials", "sfmc-credentials", "contentAssets", "rendering" ] }, "Share": { "type": "object", "required": [ "user", "additionalPermissions" ], "properties": { "user": { "type": "string", "description": "User ID" }, "additionalPermissions": { "type": "array", "description": "Additional Permissions", "items": { "type": "string", "enum": [ "READ", "EDIT", "DELETE", "SHARE" ] } } } }, "Snapshot": { "type": "object", "required": [ "id", "comment", "createdDate", "createdBy", "createdFrom", "type", "contentRoot", "rootContentItems", "_links" ], "properties": { "id": { "$ref": "#/components/schemas/Id" }, "comment": { "description": "Comment", "type": "string", "minLength": 1, "example": "This is a example snapshot." }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "createdBy": { "description": "User who created the Snapshot", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff", "readOnly": true }, "createdFrom": { "description": "Indicates if this Snapshot was created by an Edition or a Content-Item", "type": "string", "enum": [ "content-item", "edition" ], "example": "content-item" }, "type": { "description": "Indicates the type of Snapshot (USER or SYSTEM)", "type": "string", "enum": [ "USER", "SYSTEM" ], "example": "USER" }, "meta": { "description": "Meta information", "type": "array", "readOnly": true, "items": { "type": "object", "properties": { "key": { "type": "string", "description": "meta key", "example": "example-key" }, "value": { "type": "string", "description": "meta value", "example": "example value" } } } }, "taggedEdition": { "description": "Tagged Editions", "type": "array", "readOnly": true, "items": { "type": "object", "properties": { "editionId": { "type": "string", "description": "Edition ID", "example": "00112233445566778899aabb" }, "createdDate": { "type": "string", "description": "Created Date", "example": "2019-01-01T00:00:00.000Z" }, "createdBy": { "type": "string", "description": "Who created the Edition", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "name": { "type": "string", "description": "Edition Name", "example": "Example Edition 1" }, "editionName": { "type": "string", "description": "Edition Name", "example": "Example Edition 1" } } } }, "locale": { "description": "The locale", "type": "string", "readOnly": true, "example": "en-US" }, "contentRoot": { "description": "ID of the root Content-Item", "writeOnly": true, "example": "00112233-4455-6677-8899-aabbccddeeff" }, "rootContentItem": { "$ref": "#/components/schemas/SnapshotRootContentItem" }, "rootContentItems": { "readOnly": true, "description": "Collection of all the root content items", "type": "array", "items": { "$ref": "#/components/schemas/SnapshotRootContentItem" } }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "required": [ "self", "snapshot", "hub" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb" } } } ] }, "snapshot": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Snapshot HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb" } } } ] }, "publishing-jobs": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "List all Publishing-Jobs for this Snapshot HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/publishing-jobs{?page,size,sort}" } } } ] }, "create-publishing-job": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Create a Publishing-Job for this Snapshot HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/publishing-jobs" } } } ] }, "edition-links": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Editions links for this Snapshot HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links" } } } ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" } } } ] }, "content-root": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Content root for this Snapshot HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb" } } } ] }, "snapshot-content-item": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Get versioned the Content-Item within this Snapshot HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/content-items{/id}" } } } ] } } } } }, "SnapshotEditionLink": { "type": "object", "required": [ "editionId", "createdDate", "createdBy", "edition", "_links" ], "properties": { "editionId": { "$ref": "#/components/schemas/Id" }, "createdDate": { "description": "Date link was created", "type": "string", "example": "2019-01-01T00:00:00Z", "readOnly": true }, "createdBy": { "description": "User who created the Snapshot Edition Link", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff", "readOnly": true }, "edition": { "description": "Edition ID", "type": "string", "example": "00112233445566778899aabb", "writeOnly": true }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "required": [ "edition", "delete" ], "properties": { "edition": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Edition HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" } } } ] }, "delete": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Delete Snapshot Edition link HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links/00112233445566778899aabb" } } } ] } } } } }, "SnapshotEditionLinkListResponse": { "allOf": [ { "type": "object", "required": [ "_embedded" ], "properties": { "_embedded": { "type": "object", "required": [ "edition-links" ], "properties": { "edition-links": { "type": "array", "items": { "$ref": "#/components/schemas/SnapshotEditionLink" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "required": [ "_links" ], "properties": { "_links": { "type": "object", "required": [ "self", "first", "last" ], "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links?page=0&size=20" } } } ] } } } } } ] }, "SnapshotFacet": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "readOnly": true, "properties": { "snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "$ref": "#/components/schemas/Facet" } ] }, "SnapshotHierarchies": { "type": "object", "properties": { "hierarchyNodeIds": { "description": "ID's", "type": "array", "example": [ "00112233-4455-6677-8899-aabbccddeeff" ] }, "getDescendants": { "type": "boolean", "example": false }, "type": { "description": "Indicates the type of Snapshot (USER or SYSTEM)", "type": "string", "enum": [ "USER", "SYSTEM" ] }, "comment": { "description": "Comment", "type": "string", "minLength": 1, "maxLength": 250, "example": "This is a example snapshot." } } }, "SnapshotListResponse": { "allOf": [ { "type": "object", "required": [ "_embedded" ], "properties": { "_embedded": { "type": "object", "required": [ "snapshots" ], "properties": { "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "required": [ "self", "first", "last", "search" ], "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb?page=0&size=20" } } } ] }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb?page=0&size=20" } } } ] }, "search": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Snapshot Search HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/search" } } } ] } } } } } ] }, "SnapshotRootContentItem": { "description": "A content graph entry point", "type": "object", "readOnly": true, "properties": { "label": { "description": "Label of the root Content-Item", "type": "string", "example": "Banner Ad Homepage" }, "contentTypeUri": { "description": "Content-Type URI of the root Content-Item's", "type": "string", "example": "Banner Ad Homepage" }, "id": { "description": "ID of the root Content-Item", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" } } }, "UpdateMultipleContentItems": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "properties": { "body": { "description": "Body", "type": "object", "properties": { "_meta": { "description": "Meta information", "type": "object", "properties": { "name": { "description": "Name", "type": "string", "example": "Name" }, "schema": { "description": "Schema", "type": "string", "format": "uri", "example": "http://deliver.bigcontent.io/schema/nested/nested-type.json" } } }, "heading": { "description": "Heading", "type": "string", "example": "Heading" }, "link": { "description": "Link", "type": "string", "format": "uri", "example": "http://anyafinn.com/buymore?campaign=shouting" } } }, "label": { "description": "Label", "type": "string", "example": "Label" }, "version": { "description": "Version", "type": "number", "minimum": 1, "example": 1 }, "folderId": { "description": "Folder ID", "type": "string", "example": "00112233445566778899aabb" }, "assignees": { "description": "Assignee", "type": "string", "example": "00112233445566778899aabb" }, "id": { "description": "ID", "type": "string", "format": "uuid", "example": "00112233-4455-6677-8899-aabbccddeeff" } } } }, "UpdateMultipleContentItemsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "status": { "description": "HTTP Status Code", "type": "number", "example": 200 }, "code": { "description": "Status", "type": "string", "example": "SUCCESS" }, "level": { "description": "Level", "type": "string", "enum": [ "INFO", "WARNING", "ERROR", "FATAL" ], "example": "INFO" }, "message": { "description": "Message", "type": "string", "example": null } } } } } }, "User": { "type": "object", "properties": { "username": { "description": "User supplied username", "type": "string", "minLength": 4, "example": "John78" }, "firstName": { "description": "User first name", "type": "string", "minLength": 1, "example": "John" }, "lastName": { "description": "User last name", "type": "string", "minLength": 1, "example": "Smith" } } }, "UUID": { "description": "ID", "type": "string", "example": "00112233-4455-6677-8899-aabbccddeeff", "readOnly": true, "format": "UUID" }, "Version": { "description": "Version", "type": "number", "minimum": 1, "example": 1 }, "WebhookCustomPayload": { "description": "Custom Payload", "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "description": "Type of Custom Payload", "enum": [ "text/x-handlebars-template" ] }, "value": { "type": "string", "maxLength": 2048, "example": "{{#withDeliveryContentItem contentItemId=payload.rootContentItem.id account=\"account-name\" stagingEnvironment=\"staging-environment-url\"}} ... {/withDeliveryContentItem}}" }, "error": { "readOnly": true, "type": "object", "properties": { "message": { "type": "string", "description": "custom payload error message" } } } } }, "WebhookEvents": { "description": "List of events to register the Webhook against", "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "dynamic-content.snapshot.published", "dynamic-content.edition.scheduled", "dynamic-content.edition.unscheduled", "dynamic-content.edition.published", "dynamic-content.content-item.created", "dynamic-content.content-item.updated", "dynamic-content.content-item.assigned", "dynamic-content.content-item.workflow.updated" ], "example": "dynamic-content.snapshot.published" } }, "WebhookFilter": { "description": "Filter", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "equal": "#/components/schemas/WebhookFilterEqual", "in": "#/components/schemas/WebhookFilterIn" } }, "properties": { "type": { "type": "string", "description": "Type of filter" } }, "required": [ "type" ] }, "WebhookFilterEqual": { "description": "Equal Filter", "allOf": [ { "$ref": "#/components/schemas/WebhookFilter" }, { "type": "object", "properties": { "arguments": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "jsonPath": { "type": "string", "description": "JSON Path of the filed you wish to match", "example": "$.payload.id" } }, "required": [ "jsonPath" ] }, { "type": "object", "properties": { "value": { "type": "string", "description": "The value to compare too", "example": "abc" } }, "required": [ "value" ] } ] }, "minItems": 2, "maxItems": 2 } }, "required": [ "arguments" ] } ] }, "WebhookFilterIn": { "description": "In Filter", "allOf": [ { "$ref": "#/components/schemas/WebhookFilter" }, { "type": "object", "properties": { "arguments": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "jsonPath": { "type": "string", "description": "JSON Path of the filed you wish to match", "example": "$.payload.id" } }, "required": [ "jsonPath" ] }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string", "description": "The values to compare too", "example": "abc" }, "minItems": 1, "maxItems": 10 } }, "required": [ "value" ] } ] }, "minItems": 2, "maxItems": 2 } }, "required": [ "arguments" ] } ] }, "WebhookFilters": { "type": "array", "minItems": 0, "maxItems": 10, "items": { "$ref": "#/components/schemas/WebhookFilter" }, "example": [ { "type": "equal", "arguments": [ { "jsonPath": "$.payload.id" }, { "value": "abc" } ] }, { "type": "in", "arguments": [ { "jsonPath": "$.payload.id" }, { "value": [ "abc", "def" ] } ] }, { "type": "equal", "arguments": [ { "jsonPath": "$.payload.not_present" }, { "value": "123" } ] } ] }, "WebhookHandler": { "type": "string", "description": "Webhook handler URL", "example": "http://example.com/webhook" }, "WebhookHandlers": { "description": "List of URLs to receive the Webhook", "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/WebhookHandler" } }, "WebhookHeaders": { "description": "List of additional headers", "type": "array", "items": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "header key", "example": "X-Additional-Header" }, "value": { "type": "string", "description": "header value", "example": "abc123" }, "secret": { "type": "boolean", "description": "Indicates thats this header value is sensitive", "example": true } } } }, "WebhookHttpRequest": { "type": "object", "properties": { "url": { "type": "string" }, "headers": { "type": "object" }, "customHeaders": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "X-Custom-Header" }, "value": { "type": "string", "example": "123" }, "secret": { "type": "boolean", "description": "If true, value will be null", "example": false } } } }, "body": { "type": "string" } } }, "WebhookListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookProperties" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks?page=0&size=20" } } } ] }, "next": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Next page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks?page=1&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks?page=2&size=20" } } } ] }, "event-types": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Event types HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/event-types" } } } ] } } } } } ] }, "WebhookMethod": { "description": "Webhook HTTP method", "type": "string", "enum": [ "POST", "PUT", "PATCH", "DELETE" ], "example": "POST" }, "WebhookProperties": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "label": { "description": "Label for the Webhook", "type": "string", "example": "Snapshot Updated Webhook" }, "events": { "$ref": "#/components/schemas/WebhookEvents" }, "handlers": { "$ref": "#/components/schemas/WebhookHandlers" }, "active": { "description": "Indicates if the Webhook should be fired", "type": "boolean", "example": true }, "notifications": { "description": "List of notifications", "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "email address to notify", "example": "test@example.com" } } } }, "secret": { "$ref": "#/components/schemas/WebhookSecret" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "headers": { "$ref": "#/components/schemas/WebhookHeaders" }, "filters": { "type": "array", "minItems": 0, "maxItems": 10, "items": { "$ref": "#/components/schemas/WebhookFilter" }, "example": [ { "type": "equal", "arguments": [ { "jsonPath": "$.payload.id" }, { "value": "abc" } ] }, { "type": "in", "arguments": [ { "jsonPath": "$.payload.id" }, { "value": [ "abc", "def" ] } ] }, { "type": "equal", "arguments": [ { "jsonPath": "$.payload.not_present" }, { "value": "123" } ] } ] }, "method": { "$ref": "#/components/schemas/WebhookMethod" }, "customPayload": { "$ref": "#/components/schemas/WebhookCustomPayload" }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb" } } } ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" } } } ] }, "requests": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "List of paginated requests for this Webhook", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests{?cursor,limit}" } } } ] }, "event-types": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "List of event types for this Webhook", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/event-types" } } } ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Update a Webhook", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb" } } } ] }, "delete": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Delete link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb" } } } ] } } } } }, "WebhookRequest": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "eventId": { "$ref": "#/components/schemas/Id" }, "eventName": { "$ref": "#/components/schemas/WebhookEvents" }, "requestState": { "type": "string", "example": "SUCCESS", "enum": [ "QUEUED", "SCHEDULED", "SUCCESS", "FAILED", "PROCESSING_REQUIRED", "PROCESSING_FAILED", "FILTERED", "RESEND_REQUEST" ] }, "attempts": { "type": "integer", "example": 1 }, "request": { "$ref": "#/components/schemas/WebhookHttpRequest" }, "invocations": { "type": "array", "items": { "type": "object", "properties": { "invocationTimestamp": { "$ref": "#/components/schemas/Date" }, "request": { "type": "object", "properties": { "url": { "type": "string", "example": "http://example.com" }, "headers": { "type": "object", "properties": { "X-Amplience-Hmac-Sha256": { "type": "string", "example": "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=" }, "User-Agent": { "type": "string", "example": "Amplience-Webhook/0.1" }, "Content-Length": { "type": "string", "example": 171 }, "Content-Type": { "type": "string", "example": "application/json" } } }, "body": { "type": "string", "example": "{\"sequenceId\":1,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}" }, "response": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "headers": { "type": "array", "items": { "type": "string" }, "example": [ "Connection: close", "Server: gunicorn/19.8.1", "Date: Tue, 15 May 2018 12:07:13 GMT", "Content-Type: application/json", "Content-Length: 3", "Access-Control-Allow-Origin: *", "Access-Control-Allow-Credentials: true", "Via: 1.1 vegur" ] }, "body": { "type": "string", "example": "..." } } } } } } } }, "evaluatedFilters": { "$ref": "#/components/schemas/WebhookRequestEvaluatedFilters" }, "customPayload": { "$ref": "#/components/schemas/WebhookCustomPayload" }, "createdTimestamp": { "$ref": "#/components/schemas/CreatedDate" }, "scheduledTimestamp": { "$ref": "#/components/schemas/Date" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests/00112233445566778899aabb" } } }, "request": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Request Hal Link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests/{id}" } } } ] }, "resend": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Resend Request Hal Link\n\nOnly available for Webhook Requests that have a `requestState` that is either \"SUCCESS\", \"FAILED\" or \"PROCESSING_FAILED\"\n", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests/00112233445566778899aabb/resend" } } } ] }, "preview": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Preview Request Hal Link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests/00112233445566778899aabb/preview" } } } ] } } } } }, "WebhookRequestEvaluatedFilters": { "type": "object", "properties": { "filters": { "type": "array", "minItems": 0, "maxItems": 10, "items": { "$ref": "#/components/schemas/WebhookFilter" }, "example": [ { "type": "equal", "arguments": [ { "jsonPath": "$.payload.id" }, { "value": "abc" } ] }, { "type": "in", "arguments": [ { "jsonPath": "$.payload.id" }, { "value": [ "abc", "def" ] } ] }, { "type": "equal", "arguments": [ { "jsonPath": "$.payload.not_present" }, { "value": "123" } ] } ] }, "results": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "IGNORED", "MATCHED", "UNMATCHED" ] } } }, "example": [ { "status": "UNMATCHED" }, { "status": "MATCHED", "index": 1 }, { "status": "IGNORED" } ] } } }, "WebhookRequestListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookRequest" } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests?limit=20" } } }, "request": { "allOf": [ { "$ref": "#/components/schemas/HalLinkTemplated" }, { "type": "object", "description": "Next page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests{?cursor,limit,excludeStatus}" } } } ] }, "next": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Next page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb/requests?cursor=CURSOR&limit=20" } } } ] } } } } } ] }, "WebhookRequiredProperties": { "type": "object", "required": [ "label", "events", "handlers", "active", "secret", "method" ] }, "WebhookSecret": { "description": "Shared secret between the handler and DC", "type": "string", "example": "my-subscription-secret" }, "WorkflowStateListResponse": { "allOf": [ { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "workflow-state": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/WorkflowStateProperties" }, { "$ref": "#/components/schemas/WorkflowStateRequiredProperties" } ] } } } } } }, { "$ref": "#/components/schemas/PaginatedHalResponse" }, { "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/workflow-states?page=0&size=20" } } }, "first": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "First page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/workflow-states?page=0&size=20" } } } ] }, "last": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Last page HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/workflow-states?page=0&size=20" } } } ] } } } } } ] }, "WorkflowStateProperties": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "label": { "type": "string", "description": "Label", "example": "In Progress", "minLength": 1 }, "color": { "type": "string", "description": "Color", "example": "rgb(255,0,0)", "pattern": "/rgb\\(\\d{1,3},\\d{1,3},\\d{1,3}\\)/" }, "createdBy": { "$ref": "#/components/schemas/CreatedBy" }, "createdDate": { "$ref": "#/components/schemas/CreatedDate" }, "lastModifiedBy": { "$ref": "#/components/schemas/LastModifiedBy" }, "lastModifiedDate": { "$ref": "#/components/schemas/LastModifiedDate" }, "_links": { "type": "object", "description": "Resource HAL links", "readOnly": true, "properties": { "self": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Self HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/workflow-states/00112233445566778899aabb" } } } ] }, "workflow-state": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Workflow state HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/workflow-states/00112233445566778899aabb" } } } ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Hub HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" } } } ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Update HAL link", "properties": { "href": { "example": "https://api.amplience.net/v2/content/workflow-states/00112233445566778899aabb" } } } ] } } } } }, "WorkflowStateRequiredProperties": { "required": [ "label", "color" ] } }, "parameters": { "contentItemIdPath": { "in": "path", "name": "contentItemId", "schema": { "type": "string" }, "required": true, "description": "Content Item ID", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "contentItemIdQuery": { "in": "query", "name": "id", "schema": { "type": "string" }, "required": true, "description": "Id", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "contentRepositoryIdPath": { "in": "path", "name": "contentRepositoryId", "schema": { "type": "string" }, "required": true, "description": "Content Repository ID", "example": "00112233445566778899aabb" }, "editionContentIdPath": { "in": "path", "name": "editionContentId", "schema": { "type": "string" }, "required": true, "description": "Edition Content ID", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "editionIdPath": { "in": "path", "name": "editionId", "schema": { "type": "string" }, "required": true, "description": "Edition Id", "example": "00112233445566778899aabb" }, "editionSlotIdPath": { "in": "path", "name": "editionSlotId", "schema": { "type": "string" }, "required": true, "description": "Edition Slot ID", "example": "00112233445566778899aabb" }, "eventIdPath": { "in": "path", "name": "eventId", "schema": { "type": "string" }, "required": true, "description": "Event Id", "example": "00112233445566778899aabb" }, "eventIdQuery": { "in": "query", "name": "eventId", "schema": { "type": "string" }, "required": true, "description": "Event Id", "example": "00112233445566778899aabb" }, "hubId": { "in": "path", "name": "hubId", "schema": { "type": "string" }, "required": true, "description": "Hub ID", "example": "00112233445566778899aabb" }, "idQuery": { "in": "query", "name": "id", "schema": { "type": "string" }, "required": true, "description": "Id", "example": "00112233445566778899aabb" }, "slotIdPath": { "in": "path", "name": "slotId", "schema": { "type": "string" }, "required": true, "description": "Slot ID", "example": "00112233-4455-6677-8899-aabbccddeeff" }, "versionPath": { "in": "path", "name": "version", "schema": { "type": "string" }, "required": true, "description": "Version", "example": 1 }, "versionQuery": { "in": "query", "name": "version", "schema": { "type": "number" }, "required": true, "description": "Version", "example": 1 } }, "examples": { "ContentItem": { "value": { "body": { "_meta": { "name": "main-banner", "schema": "http://example.com/banner.json", "deliveryKey": "promo-page/main-banner" }, "heading": "Buy more stuff!!", "link": "http://anyafinn.com/buymore?campaign=shouting" }, "label": "Banner Ad Homepage", "folderId": "00112233445566778899aabb", "locale": "en", "assignees": [ "a79f0b27-5934-4154-9cda-36399e011c68", "cbda3aa3-ebc4-4bb1-84a5-d9b31990c703" ] } }, "ContentItemResponse": { "value": { "id": "00112233-4455-6677-8899-aabbccddeeff", "contentRepositoryId": "00112233445566778899aabb", "folderId": "00112233445566778899aabb", "body": { "_meta": { "name": "main-banner", "schema": "http://example.com/banner.json", "deliveryKey": "promo-page/main-banner" }, "heading": "Buy more stuff!!", "link": "http://anyafinn.com/buymore?campaign=shouting" }, "version": 1, "label": "Banner Ad Homepage", "status": "ACTIVE", "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "deliveryId": "00112233-4455-6677-8899-aabbccddeeff", "assignee": "00112233-4455-6677-8899-aabbccddeeff", "assignedDate": "2019-01-01T00:00:00.000Z", "_links": { "self": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" }, "content-item": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}", "templated": true }, "planned": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}", "templated": true }, "publish": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish" }, "update": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" }, "restore-version": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/restore" }, "content-repository": { "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" }, "content-item-version": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}", "templated": true }, "content-item-versions": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}", "templated": true }, "content-item-history": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history{?page,size,sort}", "templated": true }, "copy": { "href": "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=00112233-4455-6677-8899-aabbccddeeff", "templated": true }, "unarchive": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/unarchive" }, "archive": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/archive" }, "set-delivery-key": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/delivery-key" }, "set-locale": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/locale" }, "create-localizations": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localize" }, "localizations": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localizations{?page,size,sort}", "templated": true }, "localization-jobs": { "href": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff{&page,size,sort}", "templated": true }, "edition-slot-associations": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/edition-slot-associations" }, "edit-workflow": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/workflow" }, "content-item-with-children": { "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5fc10d4f-63f3-485c-9230-59867f71eddc" } } } }, "CopyContentItem": { "value": { "body": { "_meta": { "name": "main-banner", "schema": "http://example.com/banner.json" }, "heading": "Buy more stuff!!", "link": "http://anyafinn.com/buymore?campaign=shouting" }, "label": "Banner Ad Homepage", "folderId": "00112233445566778899aabb", "locale": "en" } }, "CopyContentItemResponse": { "value": { "id": "00112233-4455-6677-8899-aabbccddeeff", "contentRepositoryId": "00112233445566778899aabb", "folderId": "00112233445566778899aabb", "body": { "_meta": { "name": "main-banner", "schema": "http://example.com/banner.json" }, "heading": "Buy more stuff!!", "link": "http://anyafinn.com/buymore?campaign=shouting" }, "version": 1, "label": "Banner Ad Homepage", "status": "ACTIVE", "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "deliveryId": "00112233-4455-6677-8899-aabbccddeeff", "_links": { "self": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" }, "content-item": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}", "templated": true }, "planned": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}", "templated": true }, "publish": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish" }, "update": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff" }, "restore-version": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/restore" }, "content-repository": { "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb" }, "content-item-version": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}", "templated": true }, "content-item-versions": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}", "templated": true }, "content-item-history": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history{?page,size,sort}", "templated": true }, "copy": { "href": "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=00112233-4455-6677-8899-aabbccddeeff", "templated": true }, "unarchive": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/unarchive" }, "archive": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/archive" }, "set-delivery-key": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/delivery-key" }, "set-locale": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/locale" }, "create-localizations": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localize" }, "localizations": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localizations{?page,size,sort}", "templated": true }, "localization-jobs": { "href": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff{&page,size,sort}", "templated": true }, "edition-slot-associations": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/edition-slot-associations" }, "edit-workflow": { "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/workflow" }, "content-item-with-children": { "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5fc10d4f-63f3-485c-9230-59867f71eddc" } } } }, "EditionContentAssociateResponse": { "value": { "id": "00112233445566778899aabb", "eventId": "00112233445566778899aabb", "editionId": "00112233445566778899aabb", "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "content": { "body": { "_meta": { "schema": "http://deliver.bigcontent.io/schema/hierarchy/hierarchy-schema.json", "rootContentItemIds": [ "00112233-4455-6677-8899-aabbccddeeff" ], "locked": true }, "id": "00112233445566778899aabb,", "contentType": "http://example.com/banner.json" } }, "status": "Active", "empty": true, "_links": { "self": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents" }, "edition-contents": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents" }, "edition": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" } } } }, "EditionContentCreateResponse": { "value": { "id": "00112233445566778899aabb", "eventId": "00112233445566778899aabb", "editionId": "00112233445566778899aabb", "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "content": { "body": { "_meta": { "schema": "http://deliver.bigcontent.io/schema/hierarchy/hierarchy-schema.json", "name": "Name" } } }, "status": "Active", "label": "Banner Ad Homepage", "conflicts": false, "empty": true, "_links": { "self": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents" }, "edition-contents": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents" }, "edition": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" } } } }, "EditionFindByDateWithEventResponse": { "value": { "_embedded": { "editions": [ { "id": "00112233445566778899aabb", "name": "Edition", "comment": "This is an Edition", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "eventId": "00112233445566778899aabb", "publishingStatus": "DRAFT", "slotsRemaining": 200, "schedulingErrors": null, "activeEndDate": false, "publishingJobId": "00112233445566778899aabb", "statusUpdated": "2019-01-01T00:00:00.000Z", "schedulingUser": null, "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "stagedDate": "2019-01-01T00:00:00.000Z", "slotCollisions": false, "event": { "id": "00112233445566778899aabb", "name": "Event", "comment": "This is an Event", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "brief": "http://host/test/brief", "locales": [ "en-GB" ] }, "_links": { "self": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "editions": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "create-preview": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview" }, "preview": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview" }, "schedule": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}", "templated": true }, "update": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "delete": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "list-slots": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}", "templated": true }, "slots": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots" }, "copy-slots": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}", "templated": null }, "event": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "edition-conflicts": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts" }, "edition-conflict": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts/findByIdVersion{?id,version}", "templated": true }, "slot-collisions": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slot-collisions" } } } ] }, "_links": { "self": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20", "first": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20", "last": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20", "search": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20" }, "page": { "size": 20, "totalElements": 1, "totalPages": 1, "number": 0 } } }, "EditionsFindByDateResponse": { "value": { "_embedded": { "editions": [ { "id": "00112233445566778899aabb", "name": "Edition", "comment": "This is an Edition", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "eventId": "00112233445566778899aabb", "publishingStatus": "DRAFT", "slotsRemaining": 200, "schedulingErrors": null, "activeEndDate": false, "publishingJobId": "00112233445566778899aabb", "statusUpdated": "2019-01-01T00:00:00.000Z", "schedulingUser": null, "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "stagedDate": "2019-01-01T00:00:00.000Z", "slotCollisions": false, "_links": { "self": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "editions": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "create-preview": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview" }, "preview": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview" }, "schedule": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}", "templated": true }, "update": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "delete": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "list-slots": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}", "templated": true }, "slots": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots" }, "copy-slots": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}", "templated": null }, "event": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "edition-conflicts": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts" }, "edition-conflict": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts/findByIdVersion{?id,version}", "templated": true }, "slot-collisions": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slot-collisions" } } } ] }, "_links": { "self": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20", "first": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20", "last": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20", "search": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20" }, "page": { "size": 20, "totalElements": 1, "totalPages": 1, "number": 0 } } }, "EditionSlotListResponse": { "value": { "_embedded": { "slots": [ { "id": "00112233445566778899aabb", "eventId": "00112233445566778899aabb", "editionId": "00112233445566778899aabb", "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "content": { "body": { "_meta": { "schema": "http://deliver.bigcontent.io/schema/simple-slot-type.json", "name": "Name" } } }, "status": "VALID", "slotStatus": "ACTIVE", "contentTypeId": "00112233445566778899aabb", "slotId": "00112233445566778899aabb", "slotLabel": "Slot Label", "conflicts": false, "locale": null, "empty": true, "_links": { "self": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb" }, "edition-slot": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb" }, "edition": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "slot": { "href": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb?projection", "templated": true }, "content": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content" }, "safe-update-content": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content?lastModifiedDatepagesizesort", "templated": true } } } ] }, "_links": { "self": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20" }, "first": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20" }, "last": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20" } }, "page": { "size": 20, "totalElements": 2, "totalPages": 1, "number": 0 } } }, "EditionSlotResponse": { "value": { "id": "00112233445566778899aabb", "eventId": "00112233445566778899aabb", "editionId": "00112233445566778899aabb", "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "content": { "body": { "_meta": { "schema": "http://deliver.bigcontent.io/schema/simple-slot-type.json", "name": "Name" } } }, "status": "VALID", "slotStatus": "ACTIVE", "contentTypeId": "00112233445566778899aabb", "slotId": "00112233445566778899aabb", "slotLabel": "Slot Label", "conflicts": false, "locale": null, "empty": true, "_links": { "self": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb" }, "edition-slot": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb" }, "edition": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb" }, "slot": { "href": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb?projection", "templated": true }, "content": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content" }, "safe-update-content": { "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content?lastModifiedDatepagesizesort", "templated": true } } } }, "EventListResponse": { "value": { "_embedded": { "events": [ { "id": "00112233445566778899aabb", "name": "Event", "comment": "This is an example Event", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "brief": "http://external.doc/mybrief", "locales": [ "en-GB", "it" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "event": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "hub": { "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" }, "update": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "delete": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "archive": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive" }, "create-edition": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}" }, "editions": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}" } } } ] }, "_links": { "self": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20", "first": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20", "last": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20", "search": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events/search" }, "page": { "size": 20, "totalElements": 5, "totalPages": 1, "number": 0 } } }, "EventListWithEditionsResponse": { "value": { "_embedded": { "events": [ { "id": "00112233445566778899aabb", "name": "Event", "comment": "This is an example Event", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "brief": "http://external.doc/mybrief", "locales": [ "en-GB", "it" ], "editions": [ { "id": "00112233445566778899aabb", "name": "My Edition", "comment": "This is an example edition.", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "eventId": "00112233445566778899aabb", "publishingStatus": "DRAFT", "slotsRemaining": 200, "schedulingErrors": null, "activeEndDate": false, "publishingJobId": null, "statusUpdated": "2019-01-01T00:00:00.000Z", "schedulingUser": null, "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "stagedDate": null, "slotCollisions": false } ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "event": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "hub": { "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" }, "update": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "delete": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "archive": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive" }, "create-edition": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}" }, "editions": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}" } } } ] }, "_links": { "self": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20", "first": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20", "last": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20", "search": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events/search" }, "page": { "size": 20, "totalElements": 5, "totalPages": 1, "number": 0 } } }, "EventResponse": { "value": { "id": "00112233445566778899aabb", "name": "Event", "comment": "This is an example Event", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "brief": "http://external.doc/mybrief", "locales": [ "en-GB", "it" ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "event": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "hub": { "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" }, "update": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "delete": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "archive": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive" }, "create-edition": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}" }, "editions": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}" } } } }, "EventWithEditionsResponse": { "value": { "id": "00112233445566778899aabb", "name": "Event2", "comment": "This is an example Event", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "brief": "http://external.doc/mybrief", "locales": [ "en-GB", "it" ], "editions": [ { "id": "00112233445566778899aabb", "name": "My Edition", "comment": "This is an example edition.", "start": "2019-01-01T00:00:00.000Z", "end": "2019-01-01T00:00:00.000Z", "eventId": "00112233445566778899aabb", "publishingStatus": "DRAFT", "slotsRemaining": 200, "schedulingErrors": null, "activeEndDate": false, "publishingJobId": null, "statusUpdated": "2019-01-01T00:00:00.000Z", "schedulingUser": null, "createdBy": "00112233-4455-6677-8899-aabbccddeeff", "createdDate": "2019-01-01T00:00:00.000Z", "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff", "lastModifiedDate": "2019-01-01T00:00:00.000Z", "stagedDate": null, "slotCollisions": false } ], "_links": { "self": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "event": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "hub": { "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb" }, "update": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "delete": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb" }, "archive": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive" }, "create-edition": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}" }, "editions": { "href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}" } } } }, "SlotContentItem": { "value": { "body": { "_meta": { "name": "simple-slot", "schema": "http://example.com/simple-slot-type.json" } }, "label": "Simple Slot" } } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://auth.amplience.net/oauth/token", "scopes": {} } } } } } }