Skip to main content
API docs by Redocly

Perfection.Oversite.Management.Api (1.0)

Download OpenAPI specification:Download

Icons

Get all icons available in Oversite

This API is used to get all available icons in Oversite.

Authorizations:
ApiKey
query Parameters
category
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

KnownProviders

Get all templated content providers available in Oversite

This API is used to get all templated content providers (known providers) supported by Oversite.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Layouts

Get all prebuilt layouts available in Oversite

This API is used to get all prebuilt layouts available in Oversite.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

SiteCleanUp

Clean up a single CSS class

This API is used to clean up a single CSS class

Authorizations:
ApiKey
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

Content type
application/json
{
  • "componentKey": "string",
  • "selector": "string",
  • "class": "string",
  • "pageId": "string",
  • "groupId": "string",
  • "instanceId": "string",
  • "replace": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Clean up a batch of CSS classes

This API is used to cleanup a batch of CSS classes.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "componentKey": "string",
  • "pageId": "string",
  • "groupId": "string",
  • "instanceId": "string",
  • "selectors": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

SiteContentProviders

Get all content providers linked to a site

This API is used to get all content providers linked to a site.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

siteId
required
string <uuid>

The Site ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Add a content provider to a site

This API is used to create a new content provider and add it to a site.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "contentProviderId": "c92a0c68-06ad-4ae2-8292-587e5e52adb1"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Remove a content provider from a site

This API is used to remove a content provider from a site.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

SiteShortcuts

Get all shortcuts linked to a site

This API is used to get all shortcuts linked to a site.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

siteId
required
string <uuid>

The Site ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Create a new shortcut

This API is used to create a new shortcut

Authorizations:
ApiKey
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

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Create a new shortcut

This API is used to reorder the shortcuts

Authorizations:
ApiKey
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

Content type
application/json
{
  • "shortcutId": "d7a43030-a414-47a2-abdf-3e006b0a5b6f",
  • "newIndex": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Get shortcut by ID

This API is used to get a shortcuts by ID.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Update a shortcut

This API is used to update a shortcut

Authorizations:
ApiKey
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

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Delete an existing shortcut

This API is used to delete an existing shortcut by its ID.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

SubscriptionContentProviders

Get all content providers linked to a subscription

This API is used to list all content providers linked to a subscription.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Create a new content provider

This API is used to create a new content provider.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Get a single content provider by its ID

This API is used to retrieve a single content provider based on its ID.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

id
required
string <uuid>

The content provider ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Update an existing content provider

This API is used to update an existing content provider based on its ID.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Delete an content provider by its ID

This API is used to delete a content provider based on its ID.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

id
required
string <uuid>

The content provider ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Subscriptions

GetOrganization

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>
organizationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

GetSubscription

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>
organizationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

SubscriptionSites

Get all sites under a subscription

This API is used to retrieve a list of sites linked to a subscription.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Create a new site

This API is used to create a new site

Authorizations:
ApiKey
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

Content type
application/json
{
  • "name": "string",
  • "domains": "string",
  • "createFromSiteId": "15948ec4-1f91-4672-a887-c10aadd0e5d9"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Get an existing site by ID

This API is used to get a site based on its ID.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

siteId
required
string <uuid>

The Site ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Update an existing site

This API is used to update an existing site.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "name": "string",
  • "uiThemeDark": true,
  • "domains": "string",
  • "deepLinksEnabled": true,
  • "layoutDesignerEnabled": true,
  • "contentDesignerEnabled": true,
  • "commentsEnabled": true,
  • "launchpadEnabled": true,
  • "themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Delete an existing site by ID

This API is used to delete an existing site by its ID.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

siteId
required
string <uuid>

The Site ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

SubscriptionThemes

Get all themes linked to a subscription

This API is used retrieve a list of themes linked to a subscription.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Update an existing theme

This API is used to update an existing theme.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "name": "string",
  • "key": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Get an existing theme

This API is used to retrieve an existing theme.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

themeKey
required
string

The theme ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

Delete an existing site

This API is used to delete an existing theme.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

themeKey
required
string

The theme ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}

SubscriptionWebhooks

Get webhook embed URL

This API is used to retrieve a URL to the webhook management portal.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": "string"
}

ThemeComponents

Get list of theme components

This API is used to get a list of existing theme components.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

themeKey
required
string

The theme ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Synchronize a list of theme components

This API is used to synchronized theme components.

Authorizations:
ApiKey
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

Array
name
required
string
key
required
string
description
required
string
Array of objects or null (SyncComponentElementModel)
Array of objects or null (SyncComponentPresetModel)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

ThemeDecorations

Get list of theme decorations

This API is used to get a list of existing theme decorations.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

themeKey
required
string

The theme ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Synchronize a list of theme decorations

This API is used to synchronized theme decorations.

Authorizations:
ApiKey
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

Array
name
required
string
class
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

ThemeLayouts

Get list of theme layouts

This API is used to get a list of existing theme layouts.

Authorizations:
ApiKey
path Parameters
subscriptionId
required
string <uuid>

The Subscription ID

themeKey
required
string

The theme ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}

Synchronize a list of theme layouts

This API is used to synchronized theme layouts.

Authorizations:
ApiKey
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

Content type
application/json
{
  • "prebuilt": [
    ],
  • "custom": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": [
    ]
}