Perfection.Oversite.Delivery.Api (1.0)
Download OpenAPI specification:Download
Get all the comments related to a specific site
This API is used to get all comments for a specific site. If a page ID is provided, the API will only return comments for that page. The response includes author details, subcomments and component or selector details.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
query Parameters
pageId | string The Page ID (optional) |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "status": 0,
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z",
- "node": {
- "identifier": "string",
- "xPath": "string",
- "targetOffsetX": 0,
- "targetOffsetY": 0
}, - "page": {
- "id": "string",
- "url": "string",
- "title": "string"
}, - "window": {
- "devicePixelRatio": 0,
- "height": 0,
- "width": 0
}, - "thread": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z"
}
], - "userAgent": "string"
}
]
}
Create a new comment related to a specific page
This API is used to create a new comment. This comment will be linked to a specific site and page. The request can optionally contain a node selector or component ID.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
query Parameters
pageId | string The Page ID |
Request Body schema: application/json
message required | string |
images | Array of strings or null |
required | object (CommentNodeModel) |
required | object (CommentPageModel) |
required | object (CommentWindowModel) |
userAgent required | string |
Responses
Request samples
- Payload
{- "message": "string",
- "images": [
- "string"
], - "node": {
- "identifier": "string",
- "xPath": "string",
- "targetOffsetX": 0,
- "targetOffsetY": 0
}, - "page": {
- "id": "string",
- "url": "string",
- "title": "string"
}, - "window": {
- "devicePixelRatio": 0,
- "height": 0,
- "width": 0
}, - "userAgent": "string"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "status": 0,
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z",
- "node": {
- "identifier": "string",
- "xPath": "string",
- "targetOffsetX": 0,
- "targetOffsetY": 0
}, - "page": {
- "id": "string",
- "url": "string",
- "title": "string"
}, - "window": {
- "devicePixelRatio": 0,
- "height": 0,
- "width": 0
}, - "thread": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z"
}
], - "userAgent": "string"
}
}
Create a new sub-comment related to a specific comment
This API is used to create a new sub-comment. This sub-comment will be linked to a specific site and comment.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
commentId required | string <uuid> The parrent comment ID |
Request Body schema: application/json
message required | string |
images | Array of strings or null |
Responses
Request samples
- Payload
{- "message": "string",
- "images": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "status": 0,
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z",
- "node": {
- "identifier": "string",
- "xPath": "string",
- "targetOffsetX": 0,
- "targetOffsetY": 0
}, - "page": {
- "id": "string",
- "url": "string",
- "title": "string"
}, - "window": {
- "devicePixelRatio": 0,
- "height": 0,
- "width": 0
}, - "thread": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z"
}
], - "userAgent": "string"
}
}
Update an existing comment
This API is used to update an existing comment.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
commentId required | string <uuid> The comment ID |
Request Body schema: application/json
id required | string <uuid> |
subscriptionId required | string <uuid> |
siteId required | string <uuid> |
status required | integer <int32> (CommentStatusEnum) Enum: 0 1 |
authorId required | string <uuid> |
required | object (IdentityModel) |
message required | string |
images | Array of strings or null |
mentions | Array of strings or null <uuid> |
createdDateTime required | string <date-time> |
required | object (CommentNodeModel) |
required | object (CommentPageModel) |
required | object (CommentWindowModel) |
Array of objects or null (SubCommentModel) | |
userAgent required | string |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "status": 0,
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z",
- "node": {
- "identifier": "string",
- "xPath": "string",
- "targetOffsetX": 0,
- "targetOffsetY": 0
}, - "page": {
- "id": "string",
- "url": "string",
- "title": "string"
}, - "window": {
- "devicePixelRatio": 0,
- "height": 0,
- "width": 0
}, - "thread": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z"
}
], - "userAgent": "string"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "status": 0,
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z",
- "node": {
- "identifier": "string",
- "xPath": "string",
- "targetOffsetX": 0,
- "targetOffsetY": 0
}, - "page": {
- "id": "string",
- "url": "string",
- "title": "string"
}, - "window": {
- "devicePixelRatio": 0,
- "height": 0,
- "width": 0
}, - "thread": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z"
}
], - "userAgent": "string"
}
}
Delete an existing comment
This API is used to delete an existing comment. Incrementally deletes any related sub-comments.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
commentId required | string <uuid> The comment ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
Update an existing sub-comment
This API is used to update an existing sub-comment.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
commentId required | string <uuid> The parrent comment ID |
subCommentId required | string <uuid> The sub-comment ID |
Request Body schema: application/json
id required | string <uuid> |
commentId required | string <uuid> |
authorId required | string <uuid> |
required | object (IdentityModel) |
message required | string |
images | Array of strings or null |
mentions | Array of strings or null <uuid> |
createdDateTime required | string <date-time> |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "status": 0,
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z",
- "node": {
- "identifier": "string",
- "xPath": "string",
- "targetOffsetX": 0,
- "targetOffsetY": 0
}, - "page": {
- "id": "string",
- "url": "string",
- "title": "string"
}, - "window": {
- "devicePixelRatio": 0,
- "height": 0,
- "width": 0
}, - "thread": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z"
}
], - "userAgent": "string"
}
}
Delete an existing sub-comment
This API is used to delete an existing sub-comment.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
commentId required | string <uuid> The parrent comment ID |
subCommentId required | string <uuid> The sub-comment ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "status": 0,
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z",
- "node": {
- "identifier": "string",
- "xPath": "string",
- "targetOffsetX": 0,
- "targetOffsetY": 0
}, - "page": {
- "id": "string",
- "url": "string",
- "title": "string"
}, - "window": {
- "devicePixelRatio": 0,
- "height": 0,
- "width": 0
}, - "thread": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "author": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "message": "string",
- "images": [
- "string"
], - "mentions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "createdDateTime": "2019-08-24T14:15:22Z"
}
], - "userAgent": "string"
}
}
Create or update a component instance
This API is used to create or update a component instance.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
Request Body schema: application/json
The component instance
groupId required | string |
componentKey required | string |
presetKey | string or null |
id | string or null |
pageId | string or null |
required | Array of objects (CreateOrUpdateComponentInstanceElementModel) |
Responses
Request samples
- Payload
{- "groupId": "string",
- "componentKey": "string",
- "presetKey": "string",
- "id": "string",
- "pageId": "string",
- "elements": [
- {
- "selector": "string",
- "class": "string"
}
]
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "groupId": "string",
- "id": "string",
- "componentKey": "string",
- "presetKey": "string",
- "isGlobal": true,
- "hasFallback": true,
- "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "createdOn": "2019-08-24T14:15:22Z",
- "version": 0,
- "published": true,
- "deleted": true,
- "publishedOn": "2019-08-24T14:15:22Z",
- "publishedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "lastUpdatedOn": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "elements": [
- {
- "selector": "string",
- "class": "string"
}
]
}
}
Delete an existing component instance
This API is used to delete an existing component instance.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
groupId required | string The group ID |
query Parameters
pageId | string The page ID |
componentId | string The component instance ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
Mark an existing component instance for deletion
This API is used to mark an existing component instance for deletion.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
groupId required | string The group ID |
query Parameters
pageId | string The page ID |
componentId | string The component instance ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "groupId": "string",
- "id": "string",
- "componentKey": "string",
- "presetKey": "string",
- "isGlobal": true,
- "hasFallback": true,
- "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "createdOn": "2019-08-24T14:15:22Z",
- "version": 0,
- "published": true,
- "deleted": true,
- "publishedOn": "2019-08-24T14:15:22Z",
- "publishedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "lastUpdatedOn": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "elements": [
- {
- "selector": "string",
- "class": "string"
}
]
}
}
Get site configuration
This API is used to get the full configuration of an existing site.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "features": [
- {
- "name": "string",
- "enabled": true
}
], - "contentProviders": [
- {
- "sysId": "string",
- "name": "string",
- "outlineColor": "string",
- "iconUrl": "string",
- "urlPattern": "string",
- "lowerCase": true,
- "iFrame": true
}
]
}
}
Get layout designer options
This API is used to get a model containing available designer options for a layout.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "layouts": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "key": "string",
- "description": "string",
- "class": "string",
- "items": 0,
- "isPrebuilt": true,
- "createdOn": "2019-08-24T14:15:22Z",
- "lastModifiedOn": "2019-08-24T14:15:22Z",
- "icons": [
- "string"
], - "category": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "key": "string",
- "icon": "string"
}
}
], - "decorations": [
- {
- "text": "string",
- "class": "string"
}
], - "widths": [
- {
- "text": "string",
- "class": "string"
}
], - "components": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "key": "string",
- "description": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "lastModifiedOn": "2019-08-24T14:15:22Z",
- "elements": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "selector": "string",
- "properties": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "ui": "string",
- "values": [
- {
- "id": null,
- "name": null,
- "value": null,
- "display": null
}
]
}
]
}
], - "presets": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "key": "string",
- "preview": "string",
- "default": true,
- "elements": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "selector": "string",
- "classes": "string"
}
]
}
]
}
]
}
}
Get all roles assigned to the context user in the Subscription
This API is used to get all roles assigned to the context user within a Subscription.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}
Get the profile of the context user in the Subscription
This API is used to get the profile of the logged in user
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}
}
Get all profiles in the Subscription
This API is used to get the profiles of the users in the Subscription
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}
]
}
Generates new access and refresh tokens based on the current refresh token provided.
This API is used to get new access token by refresh token when current access token expires.
Authorizations:
path Parameters
subscriptionId required | string <uuid> |
Request Body schema: application/json
The TokensRefreshRequest model
refreshToken | string or null |
Responses
Request samples
- Payload
{- "refreshToken": "string"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "accessToken": "string",
- "refreshToken": "string"
}
}
Get all section and component instances used on a page
This API is used to get all sections and component instances that have been registered for a page.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
query Parameters
preview | boolean Setting to retrieve preview vs published instances |
pageId | string The Page ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "sections": [
- {
- "id": "string",
- "inner": "string",
- "outer": "string",
- "isGlobal": true,
- "hasFallback": true,
- "createdOn": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "version": 0,
- "published": true,
- "deleted": true,
- "publishedOn": "2019-08-24T14:15:22Z",
- "publishedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "lastChangedOn": "2019-08-24T14:15:22Z",
- "lastChangedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}
}
], - "components": [
- {
- "groupId": "string",
- "id": "string",
- "componentKey": "string",
- "presetKey": "string",
- "isGlobal": true,
- "hasFallback": true,
- "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "createdOn": "2019-08-24T14:15:22Z",
- "version": 0,
- "published": true,
- "deleted": true,
- "publishedOn": "2019-08-24T14:15:22Z",
- "publishedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "lastUpdatedOn": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "elements": [
- {
- "selector": "string",
- "class": "string"
}
]
}
]
}
}
Publish sections and/or components
This API is used to publish the given sections and/or components.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
Request Body schema: application/json
Object referencing sections and/or components that will be published
pageId required | string |
sections required | Array of strings |
required | Array of objects (PublishComponentModel) |
Responses
Request samples
- Payload
{- "pageId": "string",
- "sections": [
- "string"
], - "components": [
- {
- "groupId": "string",
- "id": "string"
}
]
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "sections": [
- {
- "id": "string",
- "inner": "string",
- "outer": "string",
- "isGlobal": true,
- "hasFallback": true,
- "createdOn": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "version": 0,
- "published": true,
- "deleted": true,
- "publishedOn": "2019-08-24T14:15:22Z",
- "publishedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "lastChangedOn": "2019-08-24T14:15:22Z",
- "lastChangedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}
}
], - "components": [
- {
- "groupId": "string",
- "id": "string",
- "componentKey": "string",
- "presetKey": "string",
- "isGlobal": true,
- "hasFallback": true,
- "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "createdOn": "2019-08-24T14:15:22Z",
- "version": 0,
- "published": true,
- "deleted": true,
- "publishedOn": "2019-08-24T14:15:22Z",
- "publishedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "lastUpdatedOn": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "elements": [
- {
- "selector": "string",
- "class": "string"
}
]
}
]
}
}
Create or update a section
This API is used to create or update a section.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
Request Body schema: application/json
The section object
id required | string |
pageId | string or null |
inner required | string |
outer | string or null |
Responses
Request samples
- Payload
{- "id": "string",
- "pageId": "string",
- "inner": "string",
- "outer": "string"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "string",
- "inner": "string",
- "outer": "string",
- "isGlobal": true,
- "hasFallback": true,
- "createdOn": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "version": 0,
- "published": true,
- "deleted": true,
- "publishedOn": "2019-08-24T14:15:22Z",
- "publishedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "lastChangedOn": "2019-08-24T14:15:22Z",
- "lastChangedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}
}
}
Delete an existing section
This API is used to delete an existing section.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
componentId required | string The component instance ID |
query Parameters
pageId | string The page ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
Mark an existing section for deletion
This API is used to mark an existing section for deletion.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
componentId required | string The component instance ID |
query Parameters
pageId | string The page ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "string",
- "inner": "string",
- "outer": "string",
- "isGlobal": true,
- "hasFallback": true,
- "createdOn": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "version": 0,
- "published": true,
- "deleted": true,
- "publishedOn": "2019-08-24T14:15:22Z",
- "publishedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}, - "lastChangedOn": "2019-08-24T14:15:22Z",
- "lastChangedBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "avatarUrl": "string",
- "initials": "string"
}
}
}