Perfection.Oversite.Management.Api (1.0)
Download OpenAPI specification:Download
Get all icons available in Oversite
This API is used to get all available icons in Oversite.
Authorizations:
query Parameters
category | integer <int32> |
Responses
Response samples
- 200
- 401
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "url": "string"
}
]
}
Get all templated content providers available in Oversite
This API is used to get all templated content providers (known providers) supported by Oversite.
Authorizations:
Responses
Response samples
- 200
- 401
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "iconUrl": "string",
- "properties": [
- {
- "required": true,
- "title": "string",
- "key": "string",
- "hint": "string",
- "priority": 0,
- "values": [
- {
- "title": "string",
- "value": "string",
- "priority": 0
}
]
}
]
}
]
}
Get all prebuilt layouts available in Oversite
This API is used to get all prebuilt layouts available in Oversite.
Authorizations:
Responses
Response samples
- 200
- 401
{- "message": "string",
- "result": [
- {
- "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"
}
}
]
}
Clean up a single CSS class
This API is used to clean up a single CSS class
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
Request Body schema: application/json
The instructions to cleanup
componentKey required | string |
selector required | string |
class required | string |
pageId | string or null |
groupId | string or null |
instanceId | string or null |
replace | string or null |
Responses
Request samples
- Payload
{- "componentKey": "string",
- "selector": "string",
- "class": "string",
- "pageId": "string",
- "groupId": "string",
- "instanceId": "string",
- "replace": "string"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "analyzed": 0,
- "cleaned": 0
}
}
Clean up a batch of CSS classes
This API is used to cleanup a batch of CSS classes.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteName required | string The name of the site |
Request Body schema: application/json
The instructions to cleanup
componentKey required | string |
pageId | string or null |
groupId | string or null |
instanceId | string or null |
required | Array of objects (SiteCleanUpBatchRequestSelectorModel) |
Responses
Request samples
- Payload
{- "componentKey": "string",
- "pageId": "string",
- "groupId": "string",
- "instanceId": "string",
- "selectors": [
- {
- "selector": "string",
- "instructions": [
- {
- "class": "string",
- "replace": "string"
}
]
}
]
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "analyzed": 0,
- "cleaned": 0
}
}
Get all content providers linked to a site
This API is used to get all content providers linked to a site.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "sysId": "string",
- "name": "string",
- "outlineColor": "string",
- "iconUrl": "string"
}
]
}
Add a content provider to a site
This API is used to create a new content provider and add it to a site.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
Request Body schema: application/json
Content provider model
contentProviderId required | string <uuid> |
Responses
Request samples
- Payload
{- "contentProviderId": "c92a0c68-06ad-4ae2-8292-587e5e52adb1"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
Remove a content provider from a site
This API is used to remove a content provider from a site.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
contentProviderId required | string <uuid> The content provider ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
Get all shortcuts linked to a site
This API is used to get all shortcuts linked to a site.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "url": "string",
- "priority": 0,
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "iconUrl": "string"
}
]
}
Create a new shortcut
This API is used to create a new shortcut
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site Id |
Request Body schema: application/json
The new Shortcut to create
name required | string |
url required | string |
iconId required | string <uuid> |
Responses
Request samples
- Payload
{- "name": "string",
- "url": "string",
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "url": "string",
- "priority": 0,
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "iconUrl": "string"
}
}
Create a new shortcut
This API is used to reorder the shortcuts
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site Id |
Request Body schema: application/json
The Shortcut to Reorder
shortcutId required | string <uuid> |
newIndex required | integer <int32> |
Responses
Request samples
- Payload
{- "shortcutId": "d7a43030-a414-47a2-abdf-3e006b0a5b6f",
- "newIndex": 0
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "url": "string",
- "priority": 0,
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "iconUrl": "string"
}
]
}
Get shortcut by ID
This API is used to get a shortcuts by ID.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
shortcutId required | string <uuid> The Shortcut ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "url": "string",
- "priority": 0,
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "iconUrl": "string"
}
}
Update a shortcut
This API is used to update a shortcut
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site Id |
shortcutId required | string <uuid> |
Request Body schema: application/json
The Shortcut to update
name required | string |
url required | string |
iconId required | string <uuid> |
Responses
Request samples
- Payload
{- "name": "string",
- "url": "string",
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "url": "string",
- "priority": 0,
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "iconUrl": "string"
}
}
Delete an existing shortcut
This API is used to delete an existing shortcut by its ID.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
shortcutId required | string <uuid> The Shortcut ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
Get all content providers linked to a subscription
This API is used to list all content providers linked to a subscription.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Responses
Response samples
- 200
- 401
- 403
{- "message": "string",
- "result": [
- {
- "sysId": "string",
- "name": "string",
- "outlineColor": "string",
- "iconUrl": "string",
- "urlPattern": "string",
- "lowerCase": true,
- "iFrame": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "knownProviderId": "01a97ac3-7a8d-4d60-9e81-7687fb6d62b3",
- "knownProviderConfiguration": "string"
}
]
}
Create a new content provider
This API is used to create a new content provider.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Request Body schema: application/json
The content provider model
sysId required | string |
knownProviderId | string or null <uuid> |
name required | string |
outlineColor | string or null |
iconId | string or null <uuid> |
urlPattern | string or null |
lowerCase | boolean or null |
iFrame | boolean or null |
knownProviderConfiguration | string or null |
Responses
Request samples
- Payload
{- "sysId": "string",
- "knownProviderId": "01a97ac3-7a8d-4d60-9e81-7687fb6d62b3",
- "name": "string",
- "outlineColor": "string",
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "urlPattern": "string",
- "lowerCase": true,
- "iFrame": true,
- "knownProviderConfiguration": "string"
}
Response samples
- 200
- 401
- 403
{- "message": "string",
- "result": {
- "sysId": "string",
- "name": "string",
- "outlineColor": "string",
- "iconUrl": "string",
- "urlPattern": "string",
- "lowerCase": true,
- "iFrame": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "knownProviderId": "01a97ac3-7a8d-4d60-9e81-7687fb6d62b3",
- "knownProviderConfiguration": "string"
}
}
Get a single content provider by its ID
This API is used to retrieve a single content provider based on its ID.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
id required | string <uuid> The content provider ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "sysId": "string",
- "name": "string",
- "outlineColor": "string",
- "iconUrl": "string",
- "urlPattern": "string",
- "lowerCase": true,
- "iFrame": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "knownProviderId": "01a97ac3-7a8d-4d60-9e81-7687fb6d62b3",
- "knownProviderConfiguration": "string"
}
}
Update an existing content provider
This API is used to update an existing content provider based on its ID.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
id required | string <uuid> The content provider ID |
Request Body schema: application/json
The model with updated values for the content provider
sysId required | string |
knownProviderId | string or null <uuid> |
name required | string |
outlineColor | string or null |
iconId | string or null <uuid> |
urlPattern | string or null |
lowerCase | boolean or null |
iFrame | boolean or null |
knownProviderConfiguration | string or null |
Responses
Request samples
- Payload
{- "sysId": "string",
- "knownProviderId": "01a97ac3-7a8d-4d60-9e81-7687fb6d62b3",
- "name": "string",
- "outlineColor": "string",
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "urlPattern": "string",
- "lowerCase": true,
- "iFrame": true,
- "knownProviderConfiguration": "string"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "sysId": "string",
- "name": "string",
- "outlineColor": "string",
- "iconUrl": "string",
- "urlPattern": "string",
- "lowerCase": true,
- "iFrame": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c",
- "knownProviderId": "01a97ac3-7a8d-4d60-9e81-7687fb6d62b3",
- "knownProviderConfiguration": "string"
}
}
Delete an content provider by its ID
This API is used to delete a content provider based on its ID.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
id required | string <uuid> The content provider ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
GetOrganization
Authorizations:
path Parameters
subscriptionId required | string <uuid> |
organizationId required | string <uuid> |
Responses
Response samples
- 200
- 401
- 403
{- "message": "string",
- "result": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "contactEmail": "string",
- "contactName": "string",
- "contactPhone": "string",
- "country": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "legalIdentifier": "string",
- "name": "string",
- "postalCode": "string",
- "state": "string"
}
}
GetSubscription
Authorizations:
path Parameters
subscriptionId required | string <uuid> |
organizationId required | string <uuid> |
Responses
Response samples
- 200
- 401
- 403
{- "message": "string",
- "result": {
- "active": true,
- "aiCompanion": true,
- "aiTextAnalysis": true,
- "amount": 0,
- "approvalFlows": true,
- "comments": true,
- "complianceTools": true,
- "components": 0,
- "contentDesigner": true,
- "contentProviders": 0,
- "createdOn": "2019-08-24T14:15:22Z",
- "currency": "string",
- "deepLinks": true,
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "layoutDesigner": true,
- "paymentTermsInDays": 0,
- "seoAndAccessibility": true,
- "sites": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "taskManagement": true,
- "users": 0
}
}
Get all sites under a subscription
This API is used to retrieve a list of sites linked to a subscription.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Responses
Response samples
- 200
- 401
- 403
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "name": "string",
- "uiThemeDark": true,
- "domains": "string",
- "deepLinksEnabled": true,
- "layoutDesignerEnabled": true,
- "contentDesignerEnabled": true,
- "commentsEnabled": true,
- "launchpadEnabled": true,
- "themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76"
}
]
}
Create a new site
This API is used to create a new site
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Request Body schema: application/json
The new site object
name required | string |
domains required | string |
createFromSiteId | string or null <uuid> |
Responses
Request samples
- Payload
{- "name": "string",
- "domains": "string",
- "createFromSiteId": "15948ec4-1f91-4672-a887-c10aadd0e5d9"
}
Response samples
- 200
- 401
- 403
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "name": "string",
- "uiThemeDark": true,
- "domains": "string",
- "deepLinksEnabled": true,
- "layoutDesignerEnabled": true,
- "contentDesignerEnabled": true,
- "commentsEnabled": true,
- "launchpadEnabled": true,
- "themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76"
}
}
Get an existing site by ID
This API is used to get a site based on its ID.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "name": "string",
- "uiThemeDark": true,
- "domains": "string",
- "deepLinksEnabled": true,
- "layoutDesignerEnabled": true,
- "contentDesignerEnabled": true,
- "commentsEnabled": true,
- "launchpadEnabled": true,
- "themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76"
}
}
Update an existing site
This API is used to update an existing site.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
Request Body schema: application/json
The site model with updated properties
name required | string |
uiThemeDark required | boolean |
domains required | string |
deepLinksEnabled required | boolean |
layoutDesignerEnabled required | boolean |
contentDesignerEnabled required | boolean |
commentsEnabled required | boolean |
launchpadEnabled required | boolean |
themeId | string or null <uuid> |
Responses
Request samples
- Payload
{- "name": "string",
- "uiThemeDark": true,
- "domains": "string",
- "deepLinksEnabled": true,
- "layoutDesignerEnabled": true,
- "contentDesignerEnabled": true,
- "commentsEnabled": true,
- "launchpadEnabled": true,
- "themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76"
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "name": "string",
- "uiThemeDark": true,
- "domains": "string",
- "deepLinksEnabled": true,
- "layoutDesignerEnabled": true,
- "contentDesignerEnabled": true,
- "commentsEnabled": true,
- "launchpadEnabled": true,
- "themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76"
}
}
Delete an existing site by ID
This API is used to delete an existing site by its ID.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
siteId required | string <uuid> The Site ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
Get all themes linked to a subscription
This API is used retrieve a list of themes linked to a subscription.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Responses
Response samples
- 200
- 401
- 403
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "name": "string",
- "key": "string",
- "description": "string"
}
]
}
Update an existing theme
This API is used to update an existing theme.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
Request Body schema: application/json
The theme model with updated properties
name required | string |
key required | string |
description required | string |
Responses
Request samples
- Payload
{- "name": "string",
- "key": "string",
- "description": "string"
}
Response samples
- 200
- 401
- 403
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "name": "string",
- "key": "string",
- "description": "string"
}
}
Get an existing theme
This API is used to retrieve an existing theme.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
themeKey required | string The theme ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "name": "string",
- "key": "string",
- "description": "string"
}
}
Delete an existing site
This API is used to delete an existing theme.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
themeKey required | string The theme ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": {
- "status": true
}
}
Get list of theme components
This API is used to get a list of existing theme components.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
themeKey required | string The theme ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "value": "string",
- "display": "string"
}
]
}
]
}
], - "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"
}
]
}
]
}
]
}
Synchronize a list of theme components
This API is used to synchronized theme components.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
themeKey required | string The theme ID |
Request Body schema: application/json
List of components to synchronize
name required | string |
key required | string |
description required | string |
Array of objects or null (SyncComponentElementModel) | |
Array of objects or null (SyncComponentPresetModel) |
Responses
Request samples
- Payload
[- {
- "name": "string",
- "key": "string",
- "description": "string",
- "elements": [
- {
- "name": "string",
- "selector": "string",
- "properties": [
- {
- "name": "string",
- "ui": "string",
- "values": [
- {
- "name": "string",
- "value": "string",
- "display": "string"
}
]
}
]
}
], - "presets": [
- {
- "name": "string",
- "key": "string",
- "preview": "string",
- "default": true,
- "elements": [
- {
- "selector": "string",
- "classes": "string"
}
]
}
]
}
]
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "value": "string",
- "display": "string"
}
]
}
]
}
], - "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 list of theme decorations
This API is used to get a list of existing theme decorations.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
themeKey required | string The theme ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "class": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "lastModifiedOn": "2019-08-24T14:15:22Z"
}
]
}
Synchronize a list of theme decorations
This API is used to synchronized theme decorations.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
themeKey required | string The theme ID |
Request Body schema: application/json
List of decorations to synchronize
name required | string |
class required | string |
Responses
Request samples
- Payload
[- {
- "name": "string",
- "class": "string"
}
]
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "class": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "lastModifiedOn": "2019-08-24T14:15:22Z"
}
]
}
Get list of theme layouts
This API is used to get a list of existing theme layouts.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
themeKey required | string The theme ID |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "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"
}
}
]
}
Synchronize a list of theme layouts
This API is used to synchronized theme layouts.
Authorizations:
path Parameters
subscriptionId required | string <uuid> The Subscription ID |
themeKey required | string The theme ID |
Request Body schema: application/json
List of layouts to synchronize
prebuilt required | Array of strings |
required | Array of objects (SyncLayoutModel) |
Responses
Request samples
- Payload
{- "prebuilt": [
- "string"
], - "custom": [
- {
- "name": "string",
- "category": "string",
- "description": "string",
- "class": "string"
}
]
}
Response samples
- 200
- 401
- 403
- 404
{- "message": "string",
- "result": [
- {
- "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"
}
}
]
}