Get Site Details
/sites/management/api/v1/sites/{id}
Given a site identifier, read the details of the site. A site identifier is a globally unique value allocated to the site when the site is first created. Expansion can be used to read relationships of the site, such as the request that was used to request the site or the repository associated with the site (if the site is an enterprise site).
Authorization
When site governance is enabled, site administrators can read any site. When site governance is enabled approvers can also read any site they have pending approval requests for regardless of whether the site is shared with the approver. If the authenticated user or client application has been shared with the resource and has one of the following sharing roles the user will be able to read the site.
- Owner
- Manager
- Contributor
- Downloader
- Viewer
Path Alternative Identifiers
The default identifier for a Site resource is the Site Identifier. The Site resource supports alternative identifiers.
nameSite Name
Instead of the site identifier, the site name can be used to uniquely identify a site in the resource path. The default resource path parameter for a site is the site identifier, but when working with sites the human-readable site name is sometimes easier.
http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct
Introduced in release 19.4.1.
Successful Response Examples
This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.
200OK - Get the Details of a Site
Get the details of a site. This example shows that the site returned is offline site with pending draft updates. Links are not included in the response.
Request
GET https://api.example.com/sites/management/api/v1/sites/{id}?links=none
Response Body
{ "id": "F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "createdAt": "2019-06-01T06:44:17.000Z", "lastModifiedAt": "2019-06-03T06:43:57.000Z", "thumbnail": { "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559544257069", "imageType": "thumbnail" }, "isEnterprise": false, "runtimeStatus": "offline", "offlineAt": "2019-06-12T21:01:17.000Z", "onlineAt": "2019-06-01T10:56:23.000Z", "publishStatus": "draft", "publishedAt": "2019-06-01T10:48:34.000Z", "security": { "policy": { "level": "service", "appliesTo": "all" }, "access": [ "service" ] }, "themeName": "MarketingTheme", "templateName": "Marketing", "numberOfUpdates": 4, "defaultLanguage": "en-US" }
200OK - Get Details of a Soft-Deleted Site
Returns the details of a soft-deleted site, providing information such as the site name and description. Soft-deleted sites can be read only by the owner, or the user that soft deleted the site. When site governance is enabled, site administrators can read any soft-deleted site. Links are not included in the response.
Request
GET https://api.example.com/sites/management/api/v1/sites/{id}?includeDeleted=true&links=none
Response Body
{ "id": "F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "createdAt": "2019-06-01T06:44:17.000Z", "lastModifiedAt": "2019-06-03T06:43:57.000Z", "thumbnail": { "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559544257069", "imageType": "thumbnail" }, "isEnterprise": false, "isDeleted": true, "runtimeStatus": "offline", "offlineAt": "2019-06-12T21:01:17.000Z", "onlineAt": "2019-06-01T10:56:23.000Z", "publishStatus": "draft", "publishedAt": "2019-06-01T10:48:34.000Z", "security": { "policy": { "level": "cloud", "appliesTo": "all" }, "access": [ "service" ] }, "themeName": "MarketingTheme", "templateName": "Marketing", "numberOfUpdates": 0, "defaultLanguage": "en-US" }
200OK - Get Details of a Site Including Vanity Domain
Returns the details of a site with the site's vanity domain included if it has one. Expansion errors are ignored, so if the site does not have a vanity domain it will not be included in the response.
Request
GET https://api.example.com/sites/management/api/v1/sites/{id}?expand=vanityDomain&expansionErrors=ignore&links=none
Response Body
{ "id": "F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "createdAt": "2019-06-01T06:44:17.000Z", "lastModifiedAt": "2019-06-03T06:43:57.000Z", "thumbnail": { "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559544257069", "imageType": "thumbnail" }, "isEnterprise": false, "isDeleted": true, "runtimeStatus": "offline", "offlineAt": "2019-06-12T21:01:17.000Z", "onlineAt": "2019-06-01T10:56:23.000Z", "publishStatus": "draft", "publishedAt": "2019-06-01T10:48:34.000Z", "security": { "policy": { "level": "cloud", "appliesTo": "all" }, "access": [ "service" ] }, "themeName": "MarketingTheme", "templateName": "Marketing", "numberOfUpdates": 0, "defaultLanguage": "en-US", "vanityDomain": { "name": "cloud.example.com", "configurationStatus": "completed" } }Introduced in release 21.5.1.
200OK - Get the Details of a Site Including Permissions
Returns the details of a site with the authenticated user or client application site permissions. Links are not included in the response.
Request
GET https://api.example.com/sites/management/api/v1/sites/{id}?expand=permissions&links=none
Response Body
{ "id": "F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "createdAt": "2019-06-01T06:44:17.000Z", "lastModifiedAt": "2019-06-03T06:43:57.000Z", "thumbnail": { "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559544257069", "imageType": "thumbnail" }, "isEnterprise": false, "isDeleted": true, "runtimeStatus": "offline", "offlineAt": "2019-06-12T21:01:17.000Z", "onlineAt": "2019-06-01T10:56:23.000Z", "publishStatus": "draft", "publishedAt": "2019-06-01T10:48:34.000Z", "security": { "policy": { "level": "cloud", "appliesTo": "all" }, "access": [ "service" ] }, "themeName": "MarketingTheme", "templateName": "Marketing", "numberOfUpdates": 0, "defaultLanguage": "en-US", "vanityDomain": { }, "permissions": { "self": [ "preview", "read", "write", "update" ], "file": [ "preview", "read", "write", "update" ], "members": [ "read" ], "shareLink": [ "read", "create", "update", "delete" ], "annotation": [ "read", "write", "update", "delete" ], "conversation": [ "read", "write", "update", "delete" ] } }Introduced in release 22.7.2.
Client Error Response Examples
This operation responds with following client error (4xx) responses with exception details in the response body. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.
404Not Found - Site Name Ambiguous
The name provided does not uniquely identify a site. If a deleted site is referenced by name and there are multiple deleted sites with the same name this error will occur. This error provides details of the deleted sites with the same name.
Error Code
OCE-SITEMGMT-009090
Resolution - Use the Site Identifier
Use the unique site identifier instead of the name to identify the site.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
site | Site that does not exist or is not visible to the authenticated user. |
sites | Sites that match on name. |
For detailed information about this exception detail type, consult the SiteNameAmbiguousExceptionDetail schema in the definitions section of the swagger document.
Example Response Body
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Name Ambiguous", "status": "404", "detail": "Multiple sites exist with an identifier of '{site.id}'.", "o:errorCode": "OCE-SITEMGMT-009090", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" }, "sites": [ { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0", "name": "MyNewProduct", "isExpired": false, "isDeleted": false, "description": "A folder for my assets.", "createdAt": "2019-06-01T06:44:17.000Z", "lastModifiedAt": "2019-06-01T06:44:17.000Z", "thumbnail": { "url": "http://cloud.example.com/images/site.png", "imageType": "thumbnail" }, "isEnterprise": false, "themeName": "value", "defaultLanguage": "en-US", "runtimeStatus": "offline", "offlineAt": "2019-06-01T06:44:17.000Z", "onlineAt": "2019-06-01T06:44:17.000Z", "publishStatus": "unpublished", "publishedAt": "2019-06-01T06:44:17.000Z", "unpublishedAt": "2019-06-01T06:44:17.000Z", "expiresAt": "2019-06-01T06:44:17.000Z", "security": { "policy": { "level": "service", "appliesTo": "named" }, "access": [ "named" ] }, "userSecurity": { "externalUserEnabled": false }, "sitePrefix": "News", "templateName": "value", "isIframeEmbeddingAllowed": false, "numberOfUpdates": 1234, "job": { "action": "copy", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }, "staticSiteDeliveryOptions": { "compileSite": false, "cachingResponseHeaders": "Cache-control: max-age=600", "mobileUserAgents": "Mobile" }, "compilationStatus": "value", "sitePageOptions": { "urlValidationDisabled": false, "ssrEnabled": false, "ssrReady": false } } ] }
Introduced in release 20.1.1.
404Not Found - Site Not Found
The site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.
Error Code
OCE-SITEMGMT-009003
Resolution - Check Identifier
Check that the site identifier is valid.
Resolution - Check Membership
Check that the authenticated user is a member of the site or a site administrator.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
site | Site that does not exist or is not visible to the authenticated user. |
For detailed information about this exception detail type, consult the SiteNotFoundExceptionDetail schema in the definitions section of the swagger document.
Example Response Body
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Not Found", "status": "404", "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.", "o:errorCode": "OCE-SITEMGMT-009003", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
Request
-
id: string
Immutable identifier for the site.
-
excludeFields(optional): string
Comma-delimited string of field names that should not be included in the response.
-
excludeLinks(optional): string
Comma-separated list of link relation names to exclude from the response.
-
expand(optional): string
Comma-delimited string of field names that you want to expand. Use the value
all
to expand all relationships.The following field names can be specified in the
expand
query parameter:Field Name Description ownedBy
User or client application that owns this site. createdBy
User or client application that created this site. lastModifiedBy
User, client application or service that last modified this site. theme
Theme associated with the site. request
Request that caused this site to be created. members
Users and groups the site has been shared with. access
Users and groups that can access the site. permissions
User permissions for the site. vanityDomain
Vanity Domain associated with the site. updates
Updates for the site. repository
The repository associated with an enterprise site. channel
The channel associated with an enterprise site. defaultCollection
When an enterprise site is created, a repository is specified for use with that site. contentSecurity
Content security assigned to the site. siteCategory
Private site category generated for SST sites. -
expansionErrors(optional): string
Specify how errors in expansion are handled. If not specified, then the default is to include error details in the relationship field.
Valid values are:
-
ignore
- Ignore the error and do not expand the relationship. Relationship links are not included in the response -
include
- Include the error details instead of the expanded relationship. Relationship links are returned -
fail
- Fail the request with an expansion failure error response
-
-
fields(optional): string
Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.
-
includeDeleted(optional): boolean
Resources that have been marked for deletion can be read, modified, and support extended operations as long this query parameter is set to
true
. When theincludeDeleted
query parameter is not sent then the response to read, modification, and extended operations will be identical to that which would be returned if the resource was permanently deleted. -
links(optional): string
Comma-separated list of link relation names to include in the response. By default, all links are returned.
The following links are provided by this resource:
Link Relationship Description parent
Describes where the parent resource can be read. Equivalent to an up
link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.self
Describes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource. canonical
Describes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource. edit
Describes where the resource can be edited. Used on singular resources to indicate where a patch can be performed to edit an existing resource. delete
Describes where the resource can be deleted. Used on singular resources to indicate where a delete can be performed to remove an existing resource. undelete-site
Describes the undeletesite extended operation. hard-delete-site
Describes the harddeletesite extended operation. site-requests
Describes the site requests child collection. activate
Describes the activate extended operation. deactivate
Describes the deactivate extended operation. validate
Describes the validate extended operation. publish
Describes the publish extended operation. unpublish
Describes the unpublish extended operation. extend-site
Describes the extendsite extended operation. site-copy
Describes the sitecopy extended operation. translate
Describes the translate extended operation. site-refresh-cache
Describes the siterefreshcache extended operation. expire
Describes the expire extended operation. site-components
Describes the site components child collection. site-assets
Describes the site assets child collection. site-asset-types
Describes the site asset types child collection. site-members
Describes the site members child collection. site-access
Describes the site access child collection. site-updates
Describes the site updates child collection. edit-form
Describes where a template request body for editing a resource can be read. The edit form provides details of what properties can be used to edit a resource. describedBy
Describes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource. -
return(optional): string
Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the
fields
,excludeFields
,links
,excludeLinks
andexpand
query parameters.The following representations are supported with the
return
query parameter:Representation Description representation
Full resource representation includes all properties and links and expands most relationships. default
Default resource representation includes most properties and links. basic
Basic resource representation includes some properties and some links. minimal
Minimal resource representation, includes essential properties and no links.
Response
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
-
allOf
Site
A site includes information about the original request for the site, such as who requested and who approved the site as well as details about the physical site, in the form of a site folder. All sites created through requests using the approval process will have a reference to the request that was used to created them, but sites created directly will not have request details.
A site includes information about the original request for the site, such as who requested and who approved the site as well as details about the physical site, in the form of a site folder. All sites created through requests using the approval process will have a reference to the request that was used to created them, but sites created directly will not have request details.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Site-allOf[1]
object
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
object
-
access(optional):
object access
Users and groups that can access the site.
Introduced in release 19.4.3. -
channel(optional):
channel
The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.
Introduced in release 19.2.3. -
compilationStatus(optional):
string
The compilation status of the site. This can either be a custom value or one of the several know statuses e.g
Introduced in release 23.1.1.Submitted
,Compiled
andFailed
. -
contentSecurity(optional):
contentSecurity
Content security assigned to the site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
createdAt(optional):
string(date-time)
Date and time of creation. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
createdBy(optional):
createdBy
User or client application that created this site.
-
defaultCollection(optional):
defaultCollection
When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.
Introduced in release 19.2.3. -
defaultLanguage(optional):
string
Default language for translation.
-
description(optional):
string
Maximum Length:
1000
Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
-
expiresAt(optional):
string(date-time)
Expiration date for the site, if the site has been given an expiration date. An expired site cannot be activated. Date and time values are in ISO 8601
Introduced in release 19.4.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
id(optional):
string
Immutable identifier for the site.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
isDeleted(optional):
boolean
Indicates that the site has been soft deleted. The corresponding site folder will be in the trash folder of the user that owned the site.
Introduced in release 19.4.1. -
isEnterprise(optional):
boolean
Is this an Enterprise site.
-
isExpired(optional):
boolean
If a site has an expiration date then an expired indicator will also be available. If a site does not have an expiration date then this field will not be present.
Introduced in release 19.4.1. -
isIframeEmbeddingAllowed(optional):
boolean
Whether this site can be embedded in an iFrame.
-
job(optional):
job
Running job details for the site. If there is a job running for the site the details will be returned.
-
lastModifiedAt(optional):
string(date-time)
Date and time of the last modification. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
lastModifiedBy(optional):
lastModifiedBy
User, client application or service that last modified this site.
-
members(optional):
object members
Users and groups the site has been shared with.
Introduced in release 19.4.3. -
name(optional):
string
Maximum Length:
242
Human readable name for the site.
-
numberOfUpdates(optional):
integer(int32)
Number of updates made on this site.
-
offlineAt(optional):
string(date-time)
When the site was last taken offline. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
onlineAt(optional):
string(date-time)
When the site was last brought online. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601
Introduced in release 19.2.2.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
ownedBy(optional):
ownedBy
User or client application that owns this site.
-
permissions(optional):
object permissions
User permissions for the site.
Introduced in release 22.7.2. -
publishedAt(optional):
string(date-time)
When the site was last published. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
publishStatus(optional):
string
Indicates what state the site is in with respect to site artifact publication.
Valid values are:
-
unpublished
- Site is unpublished. No published files on runtime site environment -
draft
- Site has draft updates. Published files exist on runtime site environment, but there are new unapproved updates in base site -
approved
- Site has approved updates. Published files exist on runtime site environment, but there are new approved updates in base site -
published
- Site is published. Published files exist on runtime site environment
-
-
repository(optional):
repository
The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.
Introduced in release 19.2.3. -
request(optional):
request
Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.
-
runtimeStatus(optional):
string
Indicates whether the site is offline or online.
Valid values are:
-
offline
- Site is offline. Site has not been activated, or was activated and was deactivated -
online
- Site is online. Site has been activated
-
-
security(optional):
security
Site security settings.
-
siteCategory(optional):
siteCategory
Private site category generated for SST sites.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
sitePageOptions(optional):
sitePageOptions
Site page options.
Introduced in release 23.2.1. -
sitePrefix(optional):
string
Maximum Length:
15
The site prefix is used to prefix content item names that appear in a URL if the content item does not have a slug prefix. Specifying a site prefix ensures all content items for the site have a unique slug. Site prefixes are limit to 15 characters in length.
Introduced in release 19.2.3. -
staticSiteDeliveryOptions(optional):
staticSiteDeliveryOptions
Static site options.
Introduced in release 20.3.3. -
templateName(optional):
string
Name of the template that was used to create this site.
-
theme(optional):
theme
Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.
Introduced in release 19.4.1. -
themeName(optional):
string
Name of the theme used by this template.
-
thumbnail(optional):
thumbnail
Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.
-
unpublishedAt(optional):
string(date-time)
When the site was last unpublished. Date and time values are in ISO 8601
Introduced in release 19.2.2.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
updates(optional):
object updates
Updates for the site.
Introduced in release 21.9.1. -
userSecurity(optional):
userSecurity
Site security settings relating to OCE user types.
Introduced in release 21.10.2. -
vanityDomain(optional):
vanityDomain
Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.
Introduced in release 21.5.1.
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
object
REST HATEOAS link and related metadata. If responses provide links (for example, a self
link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
-
href(optional):
string
The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the
templated
property must be set totrue
. -
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
Valid values are:
-
OPTIONS
- HTTP OPTIONS -
HEAD
- HTTP HEAD -
GET
- HTTP GET -
POST
- HTTP POST -
PUT
- HTTP PUT -
PATCH
- HTTP PATCH -
DELETE
- HTTP DELETE
-
-
profile(optional):
string(uri)
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Boolean flag that specifies the
href
property is a URI or URI Template. The property can be assumed to befalse
if the property is not present.
object
Users and groups that can access the site.
Introduced in release 19.4.3.-
items:
array items
Collection of Site Access Member elements.
Introduced in release 19.4.3.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.
Introduced in release 19.2.3.-
allOf
Channel
A publishing channel determines the release rules that are applied to an item in a repository. A channel can be public and available to everyone, or secure and limited. A repository can use multiple channels. You can select specific channels to use with specific assets in the repository, letting you decide the policies to be applied in individual cases.
Content security assigned to the site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
allOf
TaxonomyCategory
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.
Introduced in release 19.2.3.-
allOf
RepositoryCollection
Collections are a way to group content items, digital assets, and documents for use on a website, external application or for marketing campaigns. Collections are specific to individual repositories and can be used to manage a subset of items in a repository. All the items in the collection will adhere to the publishing channel that is assigned to the collection.
Running job details for the site. If there is a job running for the site the details will be returned.
-
allOf
SiteJobStatus
Discriminator:
action
Background job details for site jobs.
User, client application or service that last modified this site.
object
Users and groups the site has been shared with.
Introduced in release 19.4.3.-
items:
array items
Collection of Site Member elements.
Introduced in release 19.4.1.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
object
User permissions for the site.
Introduced in release 22.7.2.-
annotation(optional):
array annotation
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
-
-
conversation(optional):
array conversation
Set of conversation permissions the user has.
Valid values are:
-
read
- Read a conversation -
write
- Write to a conversation -
update
- Update a conversation -
delete
- Delete a conversation
-
-
file(optional):
array file
Set of file level permissions the user has.
Valid values are:
-
preview
- Preview file -
read
- Read file -
write
- Write to file -
update
- Update file -
delete
- Delete file
-
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
members(optional):
array members
Set of members permissions the user has.
Valid values are:
-
read
- Read and list members -
add
- Add to members -
update
- Update members -
remove
- Remove members
-
-
self(optional):
array self
Set of folder level permissions the user has.
Valid values are:
-
preview
- Preview folder -
read
- Read folder -
write
- Write to folder -
update
- Update folder -
delete
- Delete folder
-
- shareLink(optional): array shareLink
The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.
Introduced in release 19.2.3.-
allOf
Repository
Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.
A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.
Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.
-
allOf
Request
Discriminator:
requestType
A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.
Site security settings.
-
object
SiteSecurity
Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only site administrators can change the security policy of a site.
Private site category generated for SST sites.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
allOf
TaxonomyCategory
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
Site page options.
Introduced in release 23.2.1.-
object
SitePageOptions
Site page options.
For page specific options such as disable url validation check or enable server side rendering.
Introduced in release 23.2.1.
Static site options.
Introduced in release 20.3.3.-
object
StaticSiteDeliveryOptions
Static site delivery options.
For static sites i.e. compiled sites how long these sites are cached and what mobile user-agents call for adaptive mobile layouts supported by site compilation.
Introduced in release 20.3.3.
Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.
Introduced in release 19.4.1.-
allOf
Theme
A theme defines the general look-and-feel and the overall style of a site, including color scheme, font size, font type, and page backgrounds. Themes provide visual consistency between the pages in the site. You adjust the design and add content to create a site that sells your style, your brand, and your vision.
Introduced in release 19.4.1.
Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.
object
Updates for the site.
Introduced in release 21.9.1.-
items:
array items
Collection of Site Update elements.
Introduced in release 21.9.1.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
Site security settings relating to OCE user types.
Introduced in release 21.10.2.-
object
SiteUserSecurity
Defines security settings relating to OCE user types, for instance whether the site should allow external users to be granted certain permissions
Introduced in release 21.10.2.
Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.
Introduced in release 21.5.1.-
allOf
VanityDomain
Defines a vanity domain for a site. Once configured, a vanity domain may be used in place of the site domain to access the site.
Introduced in release 21.5.1.
array
Collection of Site Access Member elements.
Introduced in release 19.4.3.All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
CollectionResource-allOf[1]
object
-
count(optional):
integer(int32)
Total number of resources in the response.
-
hasMore(optional):
boolean
Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.
-
limit(optional):
integer(int32)
Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.
-
offset(optional):
integer(int64)
Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.
-
totalResults(optional):
integer(int64)
Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the
totalResults
parameter is supported and is set totrue
by the client.
object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.4.3. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.3. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.3. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.4.3. -
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.3.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.3.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.3.A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Group-allOf[1]
object
-
displayName(optional):
string
Human-readable name for the group.
Introduced in release 19.3.1. -
groupName(optional):
string
Group name that is unique within the service instance.
Introduced in release 19.3.1. -
id(optional):
string
Unique identifer for the group.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.3.1. -
roles(optional):
array roles
Roles.
Valid values are:
-
CECServiceAdministrator
- Service Administrator
- Assign user enumerates
- Change user passwords and challenge questions
- Configure, monitor, and manage service instances
-
CECSitesAdministrator
- Sites Administrator
- Create sites, templates, themes or components
-
CECRepositoryAdministrator
- Repository Administrator -
CECDeveloperUser
- Developer User -
CECContentAdministrator
- Content Administrator
- Create new content types and publish items
-
CECStandardUser
- Standard User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- View and interact with content items in sites
- Manage and view custom properties and edit values
-
CECEnterpriseUser
- Enterprise User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Digital Assets
- Content Items (editorial content management)
- Create, manage, view, and interact with content items
- Collections
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- Manage and view custom properties and edit values
-
CECExternalUser
- External User
-
CECIntegrationUser
- Integration User
-
CECSitesVisitor
- Sites Visitor
-
-
type(optional):
string
Type of the group.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
array
Roles.
Valid values are:
-
CECServiceAdministrator
- Service Administrator
- Assign user enumerates
- Change user passwords and challenge questions
- Configure, monitor, and manage service instances
-
CECSitesAdministrator
- Sites Administrator
- Create sites, templates, themes or components
-
CECRepositoryAdministrator
- Repository Administrator -
CECDeveloperUser
- Developer User -
CECContentAdministrator
- Content Administrator
- Create new content types and publish items
-
CECStandardUser
- Standard User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- View and interact with content items in sites
- Manage and view custom properties and edit values
-
CECEnterpriseUser
- Enterprise User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Digital Assets
- Content Items (editorial content management)
- Create, manage, view, and interact with content items
- Collections
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- Manage and view custom properties and edit values
-
CECExternalUser
- External User
-
CECIntegrationUser
- Integration User
-
CECSitesVisitor
- Sites Visitor
type
Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.
Introduced in release 20.3.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Identity-allOf[1]
object
-
displayName(optional):
string
Human-readable display name.
Introduced in release 20.3.1. -
id(optional):
string
An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 20.3.1. -
name(optional):
string
Unique name, such as the user name or client application name.
Introduced in release 20.3.1. -
roles(optional):
array roles
Roles.
Valid values are:
-
CECServiceAdministrator
- Service Administrator
- Assign user enumerates
- Change user passwords and challenge questions
- Configure, monitor, and manage service instances
-
CECSitesAdministrator
- Sites Administrator
- Create sites, templates, themes or components
-
CECRepositoryAdministrator
- Repository Administrator -
CECDeveloperUser
- Developer User -
CECContentAdministrator
- Content Administrator
- Create new content types and publish items
-
CECStandardUser
- Standard User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- View and interact with content items in sites
- Manage and view custom properties and edit values
-
CECEnterpriseUser
- Enterprise User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Digital Assets
- Content Items (editorial content management)
- Create, manage, view, and interact with content items
- Collections
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- Manage and view custom properties and edit values
-
CECExternalUser
- External User
-
CECIntegrationUser
- Integration User
-
CECSitesVisitor
- Sites Visitor
-
-
type(optional):
string
Type of Identity. Valid values are:
Introduced in release 20.3.1.user
,service
,application
,unknown
.
array
Roles.
Valid values are:
-
CECServiceAdministrator
- Service Administrator
- Assign user enumerates
- Change user passwords and challenge questions
- Configure, monitor, and manage service instances
-
CECSitesAdministrator
- Sites Administrator
- Create sites, templates, themes or components
-
CECRepositoryAdministrator
- Repository Administrator -
CECDeveloperUser
- Developer User -
CECContentAdministrator
- Content Administrator
- Create new content types and publish items
-
CECStandardUser
- Standard User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- View and interact with content items in sites
- Manage and view custom properties and edit values
-
CECEnterpriseUser
- Enterprise User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Digital Assets
- Content Items (editorial content management)
- Create, manage, view, and interact with content items
- Collections
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- Manage and view custom properties and edit values
-
CECExternalUser
- External User
-
CECIntegrationUser
- Integration User
-
CECSitesVisitor
- Sites Visitor
A publishing channel determines the release rules that are applied to an item in a repository. A channel can be public and available to everyone, or secure and limited. A repository can use multiple channels. You can select specific channels to use with specific assets in the repository, letting you decide the policies to be applied in individual cases.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Channel-allOf[1]
object
-
channelTokens(optional):
array channelTokens
Tokens associated with this channel.
-
channelType(optional):
string
User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.
Valid values are:
-
public
- Public channel -
secure
- Secure channel
-
-
createdBy(optional):
string
User that created the channel.
-
createdDate(optional):
createdDate
Date and time the channel was created.
-
description(optional):
string
Human-readable description of the channel to give consumers an idea of what content this channel contains.
-
id(optional):
string
Unique identifier for the channel.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
isSiteChannel(optional):
boolean
Flag to indicate whether the channel is site channel.
-
localizationPolicy(optional):
string
Localization policy of the channel.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
name(optional):
string
Short human-readable name to identify the channel.
-
publishPolicy(optional):
string
Publish policy of the channel.
Valid values are:
-
anythingPublished
- Any asset can be published -
onlyApproved
- Only approved assets can be published
-
-
updatedBy(optional):
string
User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.
-
updatedDate(optional):
updatedDate
Date and time the channel was last updated.
Date and time the channel was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the channel was last updated.
-
object
DateTimeZone
Date, time and time zone.
-
object
ChannelToken
Authorization token that allows public access to a channel without authentication.
object
Authorization token that allows public access to a channel without authentication.
-
expirationDate(optional):
expirationDate
Date the token expires.
-
name(optional):
string
Name of the token.
-
token(optional):
string
Token value.
Date the token expires.
-
object
DateTimeZone
Date, time and time zone.
object
Date, time and time zone.
-
description(optional):
string
Description of the date, time and time zone information.
-
timezone(optional):
string
Timezone in Olson database format.
-
value(optional):
string(date-time)
Date in ISO 8601 format. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
TaxonomyCategory-allOf[1]
object
-
apiName(optional):
string
Uniquely identifies a Taxonomy Category across Taxonomies.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
description(optional):
string
Human-readable description of the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
id(optional):
string
Unique identifier for the Taxonomy Category.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
name(optional):
string
Short human-readable name to identify the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
namePath(optional):
string
Full name path from the root category to this category separated by '/'.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
parentId(optional):
string
Parent id of the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
position(optional):
integer(int32)
The position of the Taxonomy Category among its siblings.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
status(optional):
string
Taxonomy Category status.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
Collections are a way to group content items, digital assets, and documents for use on a website, external application or for marketing campaigns. Collections are specific to individual repositories and can be used to manage a subset of items in a repository. All the items in the collection will adhere to the publishing channel that is assigned to the collection.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
RepositoryCollection-allOf[1]
object
-
channels(optional):
array channels
Channels associated with the collection.
-
createdBy(optional):
string
User that created the collection.
-
createdDate(optional):
createdDate
Date and time the collection was created.
-
description(optional):
string
Human-readable description of the collection to give consumers an idea of what content this collection is for.
-
id(optional):
string
Unique identifier for the collection.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
name(optional):
string
Short human-readable name to identify the collection.
-
updatedBy(optional):
string
User that last updated the collection. If the collection has not been updated the updated by will be the user that created the collection.
-
updatedDate(optional):
updatedDate
Date and time the collection was last updated.
Date and time the collection was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the collection was last updated.
-
object
DateTimeZone
Date, time and time zone.
object
Channel identifier.
-
id(optional):
string
Unique identifier for the repository.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
name(optional):
string
Short unique human-readable name to identify the channel.
action
Background job details for site jobs.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
SiteJobStatus-allOf[1]
object
-
action(optional):
string
Type of Site Job Status. Valid values are:
,
translate
,copy
,publish
,importTranslations
,hardDelete
,copyTheme
,copyComponent
,refresh
,publishTheme
. -
completed(optional):
boolean
Whether the asynchronous job is completed or not.
-
completedPercentage(optional):
integer(int32)
A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.
-
context(optional):
string
Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.
-
endTime(optional):
string(date-time)
Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
error(optional):
object error
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
-
intervalToPoll(optional):
integer(int64)
A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.
-
message(optional):
string
Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.
-
progress(optional):
string
The current progress of the asynchronous job. These values indicate that the asynchronous job has ended:
succeeded
,failed
,aborted
. The valueblocked
means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are:pending
,processing
,paused
.Valid values are:
-
pending
- Request is waiting to run -
processing
- Request is running -
succeeded
- Request has completed successfully -
failed
- Request has failed
-
aborted
- Request was aborted
-
paused
- Request was running, but is now paused -
blocked
- Request is blocked
-
-
requestStatus(optional):
integer(int32)
HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.
-
result(optional):
result
It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the
requestStatus
property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource. -
startTime(optional):
string(date-time)
Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
object
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus
property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.
-
object
HttpResponse
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
object
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
-
headers(optional):
array headers
HTTP response headers.
-
status(optional):
object status
HTTP status code response value and reason.
object
HTTP status code response value and reason.
-
code:
integer(int32)
The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of
404
. -
reason:
string
Short, human-readable summary of the status code.
object
-
name:
string
Header name.
-
value(optional):
string
Header value.
array
Collection of Site Member elements.
Introduced in release 19.4.1.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.4.1. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.1. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.4.1. -
role:
string
Sharing role that the user, client application or group has been given.
Valid values are:
-
owner
- User is the owner -
manager
- User has Manager role -
contributor
- User has Contributor role -
downloader
- User has Downloader role -
viewer
- User has Viewer role
-
-
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.1.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.1.array
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
array
Set of conversation permissions the user has.
Valid values are:
-
read
- Read a conversation -
write
- Write to a conversation -
update
- Update a conversation -
delete
- Delete a conversation
array
Set of file level permissions the user has.
Valid values are:
-
preview
- Preview file -
read
- Read file -
write
- Write to file -
update
- Update file -
delete
- Delete file
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
array
Set of members permissions the user has.
Valid values are:
-
read
- Read and list members -
add
- Add to members -
update
- Update members -
remove
- Remove members
array
Set of folder level permissions the user has.
Valid values are:
-
preview
- Preview folder -
read
- Read folder -
write
- Write to folder -
update
- Update folder -
delete
- Delete folder
Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.
A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Repository-allOf[1]
object
-
autoTagEnabled(optional):
boolean
Whether auto tagging is enabled for the repository.
-
channels(optional):
array channels
Channels associated with the repository.
-
contentTypes(optional):
array contentTypes
Content types associated with the repository.
-
createdBy(optional):
string
User that created the repository.
-
createdDate(optional):
createdDate
Date and time the repository was created.
-
defaultLanguage(optional):
string
Default language of the repository.
-
description(optional):
string
Human-readable description of the repository to give consumers an idea of what content this repository contains.
-
id(optional):
string
Unique identifier for the repository.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
languageOptions(optional):
array languageOptions
Language options for the repository.
-
name(optional):
string
Short human-readable name to identify the repository.
-
roleName(optional):
string
The role the authenticated user has within the repository.
Valid values are:
-
owner
- Owner of the resource -
custom
- Custom role -
manager
- Manager role -
contributor
- Contributor role -
downloader
- Downloader role -
viewer
- Viewer role
-
-
updatedBy(optional):
string
User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.
-
updatedDate(optional):
updatedDate
Date and time the repository was last updated.
Date and time the repository was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the repository was last updated.
-
object
DateTimeZone
Date, time and time zone.
object
Content type identifier.
-
name(optional):
string
Content type name.
requestType
A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Request-allOf[1]
object
-
approvers(optional):
object approvers
List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.
Introduced in release 19.3.3. -
createdAt(optional):
string(date-time)
Date and time the request was created. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
createdBy(optional):
createdBy
Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.
-
failure(optional):
object failure
If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.
-
id(optional):
string
Globally unique immutable identifier for a request.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
isDeleted(optional):
boolean
Indicates that the request is has been marked as soft deleted.
-
job(optional):
object job
When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is
blocked
- blocked waiting for approval. A completed request will also have a job status that iscompleted
. -
justification(optional):
string
Maximum Length:
1000
The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
-
lastModifiedAt(optional):
string(date-time)
Date and time the request was last updated. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
original(optional):
string
Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This forked request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.
-
policy(optional):
policy
Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.
Introduced in release 19.2.1. -
requestType(optional):
string
Type of Request. Valid values are:
SiteRequest
,CopySiteRequest
. -
reviews(optional):
object reviews
Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.
-
revision(optional):
integer(int64)
Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong
ETag
value for this resource. -
status(optional):
string
Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.
Valid values are:
-
pending
- Request is pending approval -
rejected
- Request has not been approved -
approved
- Request has been approved -
failed
- Request has been approved but failed during the request processing -
complete
- Request has been approved and is now complete
-
object
List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.
Introduced in release 19.3.3.-
items:
array items
Collection of Request Approvers Member elements.
Introduced in release 19.3.3.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.
object
If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.
object
When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is blocked
- blocked waiting for approval. A completed request will also have a job status that is completed
.
-
completed:
boolean
Whether the asynchronous job is completed or not.
-
completedPercentage(optional):
integer(int32)
A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.
-
context(optional):
string
Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.
-
endTime(optional):
string(date-time)
Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
error(optional):
object error
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
-
intervalToPoll(optional):
integer(int64)
A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
message(optional):
string
Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.
-
progress:
string
The current progress of the asynchronous job. These values indicate that the asynchronous job has ended:
succeeded
,failed
,aborted
. The valueblocked
means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are:pending
,processing
,paused
.Valid values are:
-
pending
- Request is waiting to run -
processing
- Request is running -
succeeded
- Request has completed successfully -
failed
- Request has failed
-
aborted
- Request was aborted
-
paused
- Request was running, but is now paused -
blocked
- Request is blocked
-
-
requestStatus(optional):
integer(int32)
HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.
-
result(optional):
result
It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the
requestStatus
property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource. -
startTime(optional):
string(date-time)
Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.
Introduced in release 19.2.1.-
allOf
Policy
A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.
A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.
A policy can be marked as inactive which prevents the operation from being performed or requested.
object
Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.
-
items:
array items
Collection of Review elements.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
array
Collection of Request Approvers Member elements.
Introduced in release 19.3.3.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.3.3. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.3.3. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.3.3. -
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.3.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.3.object
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus
property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.
-
object
HttpResponse
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.
A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.
A policy can be marked as inactive which prevents the operation from being performed or requested.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Policy-allOf[1]
object
-
access(optional):
object access
List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the
Introduced in release 19.3.1.accessType
of the policy is set torestricted
. -
accessType(optional):
string
Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.
Valid values are:
-
everyone
- Policy, when active, is applicable to everyone -
restricted
- Policy, when active, is applicable to users that are part of the access list
-
-
approvalType(optional):
string
When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.
Valid values are:
-
automatic
- A request will automatically be approved without any human approval process involved -
admin
- Any user with the site administrator role can approve the associated request -
named
- Site creation will require approval from one user that is a member of the approvers list associated with the policy
-
-
approvers(optional):
object approvers
List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.
Introduced in release 19.3.3. -
expiration(optional):
expiration
When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.
Introduced in release 19.4.1. -
id(optional):
string
Globally unique identifier for a policy.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
localizationPolicyAllowed(optional):
boolean
If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.
Introduced in release 19.2.3. -
repository(optional):
repository
When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.
Introduced in release 19.2.3. -
revision(optional):
integer(int64)
Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong
ETag
value for this resource. -
security(optional):
security
Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.
-
sitePrefixAllowed(optional):
boolean
If
Introduced in release 19.2.3.true
, a request for a new site can include an explicit site prefix. Iffalse
, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates. -
status(optional):
string
The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is inactive then the operation cannot be performed. If the policy status is active then the operation can be performed. For example, for a policy associated with a site template, a status of active means that users can create sites from that site template.
Valid values are:
-
inactive
- Policy that is marked as inactive means the associated operation cannot be requested -
active
- Policy that is marked as active means the associated operation can be requested
-
object
List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType
of the policy is set to restricted
.
-
items:
array items
Collection of Policy Access Member elements.
Introduced in release 19.3.1.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
object
List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.
Introduced in release 19.3.3.-
items:
array items
Collection of Policy Approvers Member elements.
Introduced in release 19.3.3.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.
Introduced in release 19.4.1.-
object
SiteExpirationPeriod
Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.
Introduced in release 19.4.1.
When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.
Introduced in release 19.2.3.-
allOf
Repository
Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.
A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.
Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.
-
object
SecurityPolicy
The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.
array
Collection of Policy Access Member elements.
Introduced in release 19.3.1.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.3.1. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.1. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.3.1. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.3.1. -
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.1.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.1.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.1.array
Collection of Policy Approvers Member elements.
Introduced in release 19.3.3.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.3.3. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.3.3. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.3.3. -
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.3.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.3.object
Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.
Introduced in release 19.4.1.-
amount(optional):
integer(int32)
Amount of time used to measure site expiration.
Introduced in release 19.4.1. -
unit(optional):
string
Unit of time used to measure site expiration.
Valid values are:
-
months
- Expiration expressed in the number of months -
years
- Expiration expressed in the number of years
-
object
The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.
-
appliesTo(optional):
string
Define which types of users may access a site. Can include all users or be restricted to named users only.
Valid values are:
-
named
- Only named users within a specified level can access -
all
- All users within a specified level can access
-
-
level(optional):
string
Maximum open security level that can be set on a site.
Valid values are:
-
service
- Only service users -
cloud
- Only cloud users who can sign in to your domain -
everyone
- Anyone without signing in
-
-
allOf
Review
A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.
A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Review-allOf[1]
object
-
comment(optional):
string
Maximum Length:
1000
A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
-
createdAt(optional):
string(date-time)
Date and time that the review was created. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
decision(optional):
string
Outcome of this review, either approve or reject the request.
Valid values are:
-
approved
- Associated request is approved -
rejected
- Associated request is rejected
-
-
id(optional):
integer(int32)
Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
reviewedBy(optional):
reviewedBy
Get the details of the user or client application that created the review.
Get the details of the user or client application that created the review.
object
Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only site administrators can change the security policy of a site.
-
access(optional):
array access
The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.
Valid values are:
-
named
- Selected named users -
service
- All service users -
visitors
- All service visitors -
cloud
- All cloud users who sign in to your domain -
everyone
- Anyone without signing in
-
-
policy(optional):
policy
The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.
array
The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.
Valid values are:
-
named
- Selected named users -
service
- All service users -
visitors
- All service visitors -
cloud
- All cloud users who sign in to your domain -
everyone
- Anyone without signing in
The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.
-
object
SecurityPolicy
The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.
object
Site page options.
For page specific options such as disable url validation check or enable server side rendering.
Introduced in release 23.2.1.-
ssrEnabled(optional):
boolean
Enable server side rendering (SSR) when delivering a site page.
* New in release 23.12.1. -
ssrReady(optional):
boolean
Whether it is ready to enable server side rendering (SSR) for delivering a site page.
* New in release 23.12.1. -
urlValidationDisabled(optional):
boolean
Disable the page url validation check that occurs when delivering a site page.
Introduced in release 23.2.1.
object
Static site delivery options.
For static sites i.e. compiled sites how long these sites are cached and what mobile user-agents call for adaptive mobile layouts supported by site compilation.
Introduced in release 20.3.3.-
cachingResponseHeaders(optional):
string
Maximum Length:
2000
Caching response headers. Additional headers which are added to a site's page to override the default caching headers. By default compiled sites are cached on a user's browser for 300 seconds (5 minutes). This can be overriden by entering a valid
Introduced in release 20.3.3.Cache-control
header. If Akamai is used anEdge-Control
header can be used to override the Akamai caching configuration. -
compileSite(optional):
boolean
Compile Site. Should the site be compiled for static site delivery.
Introduced in release 20.3.3. -
mobileUserAgents(optional):
string
Maximum Length:
2000
Mobile user agents. Comma separated list of user-agent substrings to specify the user agents to generate mobile pages for. When compiling a site, mobile pages can be created to support adaptive layouts. If any part of the substring matches the browser's user-agent string, then the mobile pages are served.
Introduced in release 20.3.3.
A theme defines the general look-and-feel and the overall style of a site, including color scheme, font size, font type, and page backgrounds. Themes provide visual consistency between the pages in the site. You adjust the design and add content to create a site that sells your style, your brand, and your vision.
Introduced in release 19.4.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Theme-allOf[1]
object
-
createdAt(optional):
string(date-time)
Date and time of creation. Date and time values are in ISO 8601
Introduced in release 19.4.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
createdBy(optional):
createdBy
User or client application that created this theme.
Introduced in release 19.4.1. -
description(optional):
string
Maximum Length:
1000
Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
Introduced in release 19.4.1. -
id(optional):
string
Immutable identifier for the theme.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.1. -
isDeleted(optional):
boolean
Indicates that the theme has been soft deleted. The corresponding theme folder will be in the trash folder of the user that owned the theme.
Introduced in release 19.4.1. -
isStarter(optional):
boolean
Indicates that the theme is a starter theme. Starter themes are copies of existing themes for the purpose of experimentation when developing new sites.
Introduced in release 22.8.1. -
job(optional):
job
Status for current job assigned to the theme.
Introduced in release 21.9.1. -
lastModifiedAt(optional):
string(date-time)
Date and time of the last modification. Date and time values are in ISO 8601
Introduced in release 19.4.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
lastModifiedBy(optional):
lastModifiedBy
User, client application or service that last modified this theme.
Introduced in release 19.4.1. -
members(optional):
object members
Users and groups the theme has been shared with.
Introduced in release 19.4.3. -
name(optional):
string
Maximum Length:
255
Human readable name for the theme.
Introduced in release 19.4.1. -
ownedBy(optional):
ownedBy
User or client application that owns this theme.
Introduced in release 19.4.1. -
permissions(optional):
object permissions
User permissions for the theme.
Introduced in release 22.7.2. -
publishStatus(optional):
string
Indicates whether the theme is published or not.
Valid values are:
-
unpublished
- Theme is unpublished -
published
- Theme is published
-
User or client application that created this theme.
Introduced in release 19.4.1.Status for current job assigned to the theme.
Introduced in release 21.9.1.-
allOf
SiteJobStatus
Discriminator:
action
Background job details for site jobs.
User, client application or service that last modified this theme.
Introduced in release 19.4.1.object
Users and groups the theme has been shared with.
Introduced in release 19.4.3.-
items:
array items
Collection of Theme Member elements.
Introduced in release 19.4.1.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
User or client application that owns this theme.
Introduced in release 19.4.1.object
User permissions for the theme.
Introduced in release 22.7.2.-
annotation(optional):
array annotation
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
-
-
conversation(optional):
array conversation
Set of conversation permissions the user has.
Valid values are:
-
read
- Read a conversation -
write
- Write to a conversation -
update
- Update a conversation -
delete
- Delete a conversation
-
-
file(optional):
array file
Set of file level permissions the user has.
Valid values are:
-
preview
- Preview file -
read
- Read file -
write
- Write to file -
update
- Update file -
delete
- Delete file
-
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
members(optional):
array members
Set of members permissions the user has.
Valid values are:
-
read
- Read and list members -
add
- Add to members -
update
- Update members -
remove
- Remove members
-
-
self(optional):
array self
Set of folder level permissions the user has.
Valid values are:
-
preview
- Preview folder -
read
- Read folder -
write
- Write to folder -
update
- Update folder -
delete
- Delete folder
-
- shareLink(optional): array shareLink
array
Collection of Theme Member elements.
Introduced in release 19.4.1.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.4.1. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.1. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.4.1. -
role:
string
Sharing role that the user, client application or group has been given.
Valid values are:
-
owner
- User is the owner -
manager
- User has Manager role -
contributor
- User has Contributor role -
downloader
- User has Downloader role -
viewer
- User has Viewer role
-
-
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.1.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.1.array
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
array
Set of conversation permissions the user has.
Valid values are:
-
read
- Read a conversation -
write
- Write to a conversation -
update
- Update a conversation -
delete
- Delete a conversation
array
Set of file level permissions the user has.
Valid values are:
-
preview
- Preview file -
read
- Read file -
write
- Write to file -
update
- Update file -
delete
- Delete file
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
array
Set of members permissions the user has.
Valid values are:
-
read
- Read and list members -
add
- Add to members -
update
- Update members -
remove
- Remove members
array
Set of folder level permissions the user has.
Valid values are:
-
preview
- Preview folder -
read
- Read folder -
write
- Write to folder -
update
- Update folder -
delete
- Delete folder
Site and site template thumbnail or preview image details.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Image-allOf[1]
object
-
imageType(optional):
string
Image type.
Valid values are:
-
thumbnail
- Thumbnail representation of a site or template -
preview
- Preview image of what the site or template looks like
-
-
url(optional):
string(uri)
URL of this image.
array
Collection of Site Update elements.
Introduced in release 21.9.1.-
allOf
SiteUpdate
An update is a named collection of changes to the current base site. The changes remain in the update until you commit them and permanently update the base site.
Introduced in release 21.9.1.
An update is a named collection of changes to the current base site. The changes remain in the update until you commit them and permanently update the base site.
Introduced in release 21.9.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
SiteUpdate-allOf[1]
object
-
allowedActions(optional):
integer(int64)
Allowed user actions on the folder.
Introduced in release 22.7.2. -
createdAt(optional):
string(date-time)
Date and time of creation. Date and time values are in ISO 8601
Introduced in release 21.9.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
createdBy(optional):
createdBy
User or client application that created this resource.
Introduced in release 21.9.1. -
description(optional):
string
Maximum Length:
1000
Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
Introduced in release 21.9.1. -
id(optional):
string
Immutable identifier.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 21.9.1. -
isDeleted(optional):
boolean
Indicates that the item has been soft deleted.
Introduced in release 19.4.1. -
lastModifiedAt(optional):
string(date-time)
Date and time of the last modification. Date and time values are in ISO 8601
Introduced in release 21.9.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
lastModifiedBy(optional):
lastModifiedBy
User or client application that last modified this resource.
Introduced in release 21.9.1. -
name(optional):
string
Maximum Length:
255
Human readable name for the site update.
Introduced in release 21.9.1. -
ownedBy(optional):
ownedBy
User or client application that owns this resource.
Introduced in release 21.9.1.
User or client application that created this resource.
Introduced in release 21.9.1.User or client application that last modified this resource.
Introduced in release 21.9.1.User or client application that owns this resource.
Introduced in release 21.9.1.object
Defines security settings relating to OCE user types, for instance whether the site should allow external users to be granted certain permissions
Introduced in release 21.10.2.-
externalUserEnabled(optional):
boolean
Indicates whether a site should allow external users. If true, the site will allow some (limited) privileges for external users, including (non-managing) member roles to be given to the such users.
Introduced in release 21.10.2.
Defines a vanity domain for a site. Once configured, a vanity domain may be used in place of the site domain to access the site.
Introduced in release 21.5.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
VanityDomain-allOf[1]
object
-
configurationStatus(optional):
string
The configuration status of this vanity domain. The domain is not immediately available to users once set, configuration to make it available may take up to 60 mins to complete.
Valid values are:
-
processing
- Vanity domain configuration is in process -
completed
- Vanity domain configuration has completed -
failed
- Vanity domain configuration has failed
-
-
name(optional):
string
The vanity domain for this site.
Introduced in release 21.5.1.
{
"id":"F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC",
"name":"AcmeProductLaunch",
"description":"Marketing site for Acme New Product Launch.",
"createdAt":"2019-06-01T06:44:17.000Z",
"lastModifiedAt":"2019-06-03T06:43:57.000Z",
"thumbnail":{
"url":"https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559544257069",
"imageType":"thumbnail"
},
"isEnterprise":false,
"runtimeStatus":"offline",
"offlineAt":"2019-06-12T21:01:17.000Z",
"onlineAt":"2019-06-01T10:56:23.000Z",
"publishStatus":"draft",
"publishedAt":"2019-06-01T10:48:34.000Z",
"security":{
"policy":{
"level":"service",
"appliesTo":"all"
},
"access":[
"service"
]
},
"themeName":"MarketingTheme",
"templateName":"Marketing",
"numberOfUpdates":4,
"defaultLanguage":"en-US"
}
400 Response
401 Response
403 Response
404 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
-
allOf
SiteNameAmbiguousExceptionDetail
Introduced in release 20.1.1.
-
object
ExceptionDetail
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
-
object
SiteNameAmbiguousExceptionDetail-allOf[1]
object
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
site(optional):
string
Site that does not exist or is not visible to the authenticated user.
Introduced in release 20.1.1. -
sites(optional):
array sites
Sites that match on name.
Introduced in release 20.1.1.
array
Multiple errors can be organized in a hierarchical structure.
-
object
ExceptionDetail
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
array
Sites that match on name.
Introduced in release 20.1.1.-
allOf
Site
A site includes information about the original request for the site, such as who requested and who approved the site as well as details about the physical site, in the form of a site folder. All sites created through requests using the approval process will have a reference to the request that was used to created them, but sites created directly will not have request details.
A site includes information about the original request for the site, such as who requested and who approved the site as well as details about the physical site, in the form of a site folder. All sites created through requests using the approval process will have a reference to the request that was used to created them, but sites created directly will not have request details.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Site-allOf[1]
object
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
object
-
access(optional):
object access
Users and groups that can access the site.
Introduced in release 19.4.3. -
channel(optional):
channel
The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.
Introduced in release 19.2.3. -
compilationStatus(optional):
string
The compilation status of the site. This can either be a custom value or one of the several know statuses e.g
Introduced in release 23.1.1.Submitted
,Compiled
andFailed
. -
contentSecurity(optional):
contentSecurity
Content security assigned to the site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
createdAt(optional):
string(date-time)
Date and time of creation. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
createdBy(optional):
createdBy
User or client application that created this site.
-
defaultCollection(optional):
defaultCollection
When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.
Introduced in release 19.2.3. -
defaultLanguage(optional):
string
Default language for translation.
-
description(optional):
string
Maximum Length:
1000
Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
-
expiresAt(optional):
string(date-time)
Expiration date for the site, if the site has been given an expiration date. An expired site cannot be activated. Date and time values are in ISO 8601
Introduced in release 19.4.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
id(optional):
string
Immutable identifier for the site.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
isDeleted(optional):
boolean
Indicates that the site has been soft deleted. The corresponding site folder will be in the trash folder of the user that owned the site.
Introduced in release 19.4.1. -
isEnterprise(optional):
boolean
Is this an Enterprise site.
-
isExpired(optional):
boolean
If a site has an expiration date then an expired indicator will also be available. If a site does not have an expiration date then this field will not be present.
Introduced in release 19.4.1. -
isIframeEmbeddingAllowed(optional):
boolean
Whether this site can be embedded in an iFrame.
-
job(optional):
job
Running job details for the site. If there is a job running for the site the details will be returned.
-
lastModifiedAt(optional):
string(date-time)
Date and time of the last modification. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
lastModifiedBy(optional):
lastModifiedBy
User, client application or service that last modified this site.
-
members(optional):
object members
Users and groups the site has been shared with.
Introduced in release 19.4.3. -
name(optional):
string
Maximum Length:
242
Human readable name for the site.
-
numberOfUpdates(optional):
integer(int32)
Number of updates made on this site.
-
offlineAt(optional):
string(date-time)
When the site was last taken offline. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
onlineAt(optional):
string(date-time)
When the site was last brought online. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601
Introduced in release 19.2.2.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
ownedBy(optional):
ownedBy
User or client application that owns this site.
-
permissions(optional):
object permissions
User permissions for the site.
Introduced in release 22.7.2. -
publishedAt(optional):
string(date-time)
When the site was last published. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
publishStatus(optional):
string
Indicates what state the site is in with respect to site artifact publication.
Valid values are:
-
unpublished
- Site is unpublished. No published files on runtime site environment -
draft
- Site has draft updates. Published files exist on runtime site environment, but there are new unapproved updates in base site -
approved
- Site has approved updates. Published files exist on runtime site environment, but there are new approved updates in base site -
published
- Site is published. Published files exist on runtime site environment
-
-
repository(optional):
repository
The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.
Introduced in release 19.2.3. -
request(optional):
request
Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.
-
runtimeStatus(optional):
string
Indicates whether the site is offline or online.
Valid values are:
-
offline
- Site is offline. Site has not been activated, or was activated and was deactivated -
online
- Site is online. Site has been activated
-
-
security(optional):
security
Site security settings.
-
siteCategory(optional):
siteCategory
Private site category generated for SST sites.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
sitePageOptions(optional):
sitePageOptions
Site page options.
Introduced in release 23.2.1. -
sitePrefix(optional):
string
Maximum Length:
15
The site prefix is used to prefix content item names that appear in a URL if the content item does not have a slug prefix. Specifying a site prefix ensures all content items for the site have a unique slug. Site prefixes are limit to 15 characters in length.
Introduced in release 19.2.3. -
staticSiteDeliveryOptions(optional):
staticSiteDeliveryOptions
Static site options.
Introduced in release 20.3.3. -
templateName(optional):
string
Name of the template that was used to create this site.
-
theme(optional):
theme
Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.
Introduced in release 19.4.1. -
themeName(optional):
string
Name of the theme used by this template.
-
thumbnail(optional):
thumbnail
Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.
-
unpublishedAt(optional):
string(date-time)
When the site was last unpublished. Date and time values are in ISO 8601
Introduced in release 19.2.2.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
updates(optional):
object updates
Updates for the site.
Introduced in release 21.9.1. -
userSecurity(optional):
userSecurity
Site security settings relating to OCE user types.
Introduced in release 21.10.2. -
vanityDomain(optional):
vanityDomain
Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.
Introduced in release 21.5.1.
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
object
REST HATEOAS link and related metadata. If responses provide links (for example, a self
link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
-
href(optional):
string
The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the
templated
property must be set totrue
. -
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
Valid values are:
-
OPTIONS
- HTTP OPTIONS -
HEAD
- HTTP HEAD -
GET
- HTTP GET -
POST
- HTTP POST -
PUT
- HTTP PUT -
PATCH
- HTTP PATCH -
DELETE
- HTTP DELETE
-
-
profile(optional):
string(uri)
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Boolean flag that specifies the
href
property is a URI or URI Template. The property can be assumed to befalse
if the property is not present.
object
Users and groups that can access the site.
Introduced in release 19.4.3.-
items:
array items
Collection of Site Access Member elements.
Introduced in release 19.4.3.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.
Introduced in release 19.2.3.-
allOf
Channel
A publishing channel determines the release rules that are applied to an item in a repository. A channel can be public and available to everyone, or secure and limited. A repository can use multiple channels. You can select specific channels to use with specific assets in the repository, letting you decide the policies to be applied in individual cases.
Content security assigned to the site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
allOf
TaxonomyCategory
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.
Introduced in release 19.2.3.-
allOf
RepositoryCollection
Collections are a way to group content items, digital assets, and documents for use on a website, external application or for marketing campaigns. Collections are specific to individual repositories and can be used to manage a subset of items in a repository. All the items in the collection will adhere to the publishing channel that is assigned to the collection.
Running job details for the site. If there is a job running for the site the details will be returned.
-
allOf
SiteJobStatus
Discriminator:
action
Background job details for site jobs.
User, client application or service that last modified this site.
object
Users and groups the site has been shared with.
Introduced in release 19.4.3.-
items:
array items
Collection of Site Member elements.
Introduced in release 19.4.1.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
object
User permissions for the site.
Introduced in release 22.7.2.-
annotation(optional):
array annotation
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
-
-
conversation(optional):
array conversation
Set of conversation permissions the user has.
Valid values are:
-
read
- Read a conversation -
write
- Write to a conversation -
update
- Update a conversation -
delete
- Delete a conversation
-
-
file(optional):
array file
Set of file level permissions the user has.
Valid values are:
-
preview
- Preview file -
read
- Read file -
write
- Write to file -
update
- Update file -
delete
- Delete file
-
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
members(optional):
array members
Set of members permissions the user has.
Valid values are:
-
read
- Read and list members -
add
- Add to members -
update
- Update members -
remove
- Remove members
-
-
self(optional):
array self
Set of folder level permissions the user has.
Valid values are:
-
preview
- Preview folder -
read
- Read folder -
write
- Write to folder -
update
- Update folder -
delete
- Delete folder
-
- shareLink(optional): array shareLink
The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.
Introduced in release 19.2.3.-
allOf
Repository
Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.
A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.
Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.
-
allOf
Request
Discriminator:
requestType
A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.
Site security settings.
-
object
SiteSecurity
Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only site administrators can change the security policy of a site.
Private site category generated for SST sites.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
allOf
TaxonomyCategory
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
Site page options.
Introduced in release 23.2.1.-
object
SitePageOptions
Site page options.
For page specific options such as disable url validation check or enable server side rendering.
Introduced in release 23.2.1.
Static site options.
Introduced in release 20.3.3.-
object
StaticSiteDeliveryOptions
Static site delivery options.
For static sites i.e. compiled sites how long these sites are cached and what mobile user-agents call for adaptive mobile layouts supported by site compilation.
Introduced in release 20.3.3.
Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.
Introduced in release 19.4.1.-
allOf
Theme
A theme defines the general look-and-feel and the overall style of a site, including color scheme, font size, font type, and page backgrounds. Themes provide visual consistency between the pages in the site. You adjust the design and add content to create a site that sells your style, your brand, and your vision.
Introduced in release 19.4.1.
Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.
object
Updates for the site.
Introduced in release 21.9.1.-
items:
array items
Collection of Site Update elements.
Introduced in release 21.9.1.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
Site security settings relating to OCE user types.
Introduced in release 21.10.2.-
object
SiteUserSecurity
Defines security settings relating to OCE user types, for instance whether the site should allow external users to be granted certain permissions
Introduced in release 21.10.2.
Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.
Introduced in release 21.5.1.-
allOf
VanityDomain
Defines a vanity domain for a site. Once configured, a vanity domain may be used in place of the site domain to access the site.
Introduced in release 21.5.1.
array
Collection of Site Access Member elements.
Introduced in release 19.4.3.All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
CollectionResource-allOf[1]
object
-
count(optional):
integer(int32)
Total number of resources in the response.
-
hasMore(optional):
boolean
Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.
-
limit(optional):
integer(int32)
Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.
-
offset(optional):
integer(int64)
Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.
-
totalResults(optional):
integer(int64)
Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the
totalResults
parameter is supported and is set totrue
by the client.
object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.4.3. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.3. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.3. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.4.3. -
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.3.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.3.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.3.A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Group-allOf[1]
object
-
displayName(optional):
string
Human-readable name for the group.
Introduced in release 19.3.1. -
groupName(optional):
string
Group name that is unique within the service instance.
Introduced in release 19.3.1. -
id(optional):
string
Unique identifer for the group.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.3.1. -
roles(optional):
array roles
Roles.
Valid values are:
-
CECServiceAdministrator
- Service Administrator
- Assign user enumerates
- Change user passwords and challenge questions
- Configure, monitor, and manage service instances
-
CECSitesAdministrator
- Sites Administrator
- Create sites, templates, themes or components
-
CECRepositoryAdministrator
- Repository Administrator -
CECDeveloperUser
- Developer User -
CECContentAdministrator
- Content Administrator
- Create new content types and publish items
-
CECStandardUser
- Standard User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- View and interact with content items in sites
- Manage and view custom properties and edit values
-
CECEnterpriseUser
- Enterprise User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Digital Assets
- Content Items (editorial content management)
- Create, manage, view, and interact with content items
- Collections
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- Manage and view custom properties and edit values
-
CECExternalUser
- External User
-
CECIntegrationUser
- Integration User
-
CECSitesVisitor
- Sites Visitor
-
-
type(optional):
string
Type of the group.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
array
Roles.
Valid values are:
-
CECServiceAdministrator
- Service Administrator
- Assign user enumerates
- Change user passwords and challenge questions
- Configure, monitor, and manage service instances
-
CECSitesAdministrator
- Sites Administrator
- Create sites, templates, themes or components
-
CECRepositoryAdministrator
- Repository Administrator -
CECDeveloperUser
- Developer User -
CECContentAdministrator
- Content Administrator
- Create new content types and publish items
-
CECStandardUser
- Standard User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- View and interact with content items in sites
- Manage and view custom properties and edit values
-
CECEnterpriseUser
- Enterprise User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Digital Assets
- Content Items (editorial content management)
- Create, manage, view, and interact with content items
- Collections
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- Manage and view custom properties and edit values
-
CECExternalUser
- External User
-
CECIntegrationUser
- Integration User
-
CECSitesVisitor
- Sites Visitor
type
Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.
Introduced in release 20.3.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Identity-allOf[1]
object
-
displayName(optional):
string
Human-readable display name.
Introduced in release 20.3.1. -
id(optional):
string
An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 20.3.1. -
name(optional):
string
Unique name, such as the user name or client application name.
Introduced in release 20.3.1. -
roles(optional):
array roles
Roles.
Valid values are:
-
CECServiceAdministrator
- Service Administrator
- Assign user enumerates
- Change user passwords and challenge questions
- Configure, monitor, and manage service instances
-
CECSitesAdministrator
- Sites Administrator
- Create sites, templates, themes or components
-
CECRepositoryAdministrator
- Repository Administrator -
CECDeveloperUser
- Developer User -
CECContentAdministrator
- Content Administrator
- Create new content types and publish items
-
CECStandardUser
- Standard User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- View and interact with content items in sites
- Manage and view custom properties and edit values
-
CECEnterpriseUser
- Enterprise User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Digital Assets
- Content Items (editorial content management)
- Create, manage, view, and interact with content items
- Collections
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- Manage and view custom properties and edit values
-
CECExternalUser
- External User
-
CECIntegrationUser
- Integration User
-
CECSitesVisitor
- Sites Visitor
-
-
type(optional):
string
Type of Identity. Valid values are:
Introduced in release 20.3.1.user
,service
,application
,unknown
.
array
Roles.
Valid values are:
-
CECServiceAdministrator
- Service Administrator
- Assign user enumerates
- Change user passwords and challenge questions
- Configure, monitor, and manage service instances
-
CECSitesAdministrator
- Sites Administrator
- Create sites, templates, themes or components
-
CECRepositoryAdministrator
- Repository Administrator -
CECDeveloperUser
- Developer User -
CECContentAdministrator
- Content Administrator
- Create new content types and publish items
-
CECStandardUser
- Standard User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- View and interact with content items in sites
- Manage and view custom properties and edit values
-
CECEnterpriseUser
- Enterprise User
- Manage content (view, upload, and edit documents)
- Share content and sites with others
- Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
- Follow people
- Digital Assets
- Content Items (editorial content management)
- Create, manage, view, and interact with content items
- Collections
- Create, edit, and publish sites
- Manage and publish site themes
- Create, register, export, and import custom site components
- Create, edit, export, and import site templates
- Manage and view custom properties and edit values
-
CECExternalUser
- External User
-
CECIntegrationUser
- Integration User
-
CECSitesVisitor
- Sites Visitor
A publishing channel determines the release rules that are applied to an item in a repository. A channel can be public and available to everyone, or secure and limited. A repository can use multiple channels. You can select specific channels to use with specific assets in the repository, letting you decide the policies to be applied in individual cases.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Channel-allOf[1]
object
-
channelTokens(optional):
array channelTokens
Tokens associated with this channel.
-
channelType(optional):
string
User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.
Valid values are:
-
public
- Public channel -
secure
- Secure channel
-
-
createdBy(optional):
string
User that created the channel.
-
createdDate(optional):
createdDate
Date and time the channel was created.
-
description(optional):
string
Human-readable description of the channel to give consumers an idea of what content this channel contains.
-
id(optional):
string
Unique identifier for the channel.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
isSiteChannel(optional):
boolean
Flag to indicate whether the channel is site channel.
-
localizationPolicy(optional):
string
Localization policy of the channel.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
name(optional):
string
Short human-readable name to identify the channel.
-
publishPolicy(optional):
string
Publish policy of the channel.
Valid values are:
-
anythingPublished
- Any asset can be published -
onlyApproved
- Only approved assets can be published
-
-
updatedBy(optional):
string
User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.
-
updatedDate(optional):
updatedDate
Date and time the channel was last updated.
Date and time the channel was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the channel was last updated.
-
object
DateTimeZone
Date, time and time zone.
-
object
ChannelToken
Authorization token that allows public access to a channel without authentication.
object
Authorization token that allows public access to a channel without authentication.
-
expirationDate(optional):
expirationDate
Date the token expires.
-
name(optional):
string
Name of the token.
-
token(optional):
string
Token value.
Date the token expires.
-
object
DateTimeZone
Date, time and time zone.
object
Date, time and time zone.
-
description(optional):
string
Description of the date, time and time zone information.
-
timezone(optional):
string
Timezone in Olson database format.
-
value(optional):
string(date-time)
Date in ISO 8601 format. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
TaxonomyCategory-allOf[1]
object
-
apiName(optional):
string
Uniquely identifies a Taxonomy Category across Taxonomies.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
description(optional):
string
Human-readable description of the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
id(optional):
string
Unique identifier for the Taxonomy Category.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
name(optional):
string
Short human-readable name to identify the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
namePath(optional):
string
Full name path from the root category to this category separated by '/'.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
parentId(optional):
string
Parent id of the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
position(optional):
integer(int32)
The position of the Taxonomy Category among its siblings.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
status(optional):
string
Taxonomy Category status.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
Collections are a way to group content items, digital assets, and documents for use on a website, external application or for marketing campaigns. Collections are specific to individual repositories and can be used to manage a subset of items in a repository. All the items in the collection will adhere to the publishing channel that is assigned to the collection.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
RepositoryCollection-allOf[1]
object
-
channels(optional):
array channels
Channels associated with the collection.
-
createdBy(optional):
string
User that created the collection.
-
createdDate(optional):
createdDate
Date and time the collection was created.
-
description(optional):
string
Human-readable description of the collection to give consumers an idea of what content this collection is for.
-
id(optional):
string
Unique identifier for the collection.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
name(optional):
string
Short human-readable name to identify the collection.
-
updatedBy(optional):
string
User that last updated the collection. If the collection has not been updated the updated by will be the user that created the collection.
-
updatedDate(optional):
updatedDate
Date and time the collection was last updated.
Date and time the collection was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the collection was last updated.
-
object
DateTimeZone
Date, time and time zone.
object
Channel identifier.
-
id(optional):
string
Unique identifier for the repository.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
name(optional):
string
Short unique human-readable name to identify the channel.
action
Background job details for site jobs.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
SiteJobStatus-allOf[1]
object
-
action(optional):
string
Type of Site Job Status. Valid values are:
,
translate
,copy
,publish
,importTranslations
,hardDelete
,copyTheme
,copyComponent
,refresh
,publishTheme
. -
completed(optional):
boolean
Whether the asynchronous job is completed or not.
-
completedPercentage(optional):
integer(int32)
A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.
-
context(optional):
string
Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.
-
endTime(optional):
string(date-time)
Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
error(optional):
object error
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
-
intervalToPoll(optional):
integer(int64)
A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.
-
message(optional):
string
Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.
-
progress(optional):
string
The current progress of the asynchronous job. These values indicate that the asynchronous job has ended:
succeeded
,failed
,aborted
. The valueblocked
means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are:pending
,processing
,paused
.Valid values are:
-
pending
- Request is waiting to run -
processing
- Request is running -
succeeded
- Request has completed successfully -
failed
- Request has failed
-
aborted
- Request was aborted
-
paused
- Request was running, but is now paused -
blocked
- Request is blocked
-
-
requestStatus(optional):
integer(int32)
HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.
-
result(optional):
result
It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the
requestStatus
property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource. -
startTime(optional):
string(date-time)
Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
object
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus
property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.
-
object
HttpResponse
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
object
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
-
headers(optional):
array headers
HTTP response headers.
-
status(optional):
object status
HTTP status code response value and reason.
object
HTTP status code response value and reason.
-
code:
integer(int32)
The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of
404
. -
reason:
string
Short, human-readable summary of the status code.
object
-
name:
string
Header name.
-
value(optional):
string
Header value.
array
Collection of Site Member elements.
Introduced in release 19.4.1.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.4.1. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.1. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.4.1. -
role:
string
Sharing role that the user, client application or group has been given.
Valid values are:
-
owner
- User is the owner -
manager
- User has Manager role -
contributor
- User has Contributor role -
downloader
- User has Downloader role -
viewer
- User has Viewer role
-
-
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.1.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.1.array
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
array
Set of conversation permissions the user has.
Valid values are:
-
read
- Read a conversation -
write
- Write to a conversation -
update
- Update a conversation -
delete
- Delete a conversation
array
Set of file level permissions the user has.
Valid values are:
-
preview
- Preview file -
read
- Read file -
write
- Write to file -
update
- Update file -
delete
- Delete file
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
array
Set of members permissions the user has.
Valid values are:
-
read
- Read and list members -
add
- Add to members -
update
- Update members -
remove
- Remove members
array
Set of folder level permissions the user has.
Valid values are:
-
preview
- Preview folder -
read
- Read folder -
write
- Write to folder -
update
- Update folder -
delete
- Delete folder
Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.
A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Repository-allOf[1]
object
-
autoTagEnabled(optional):
boolean
Whether auto tagging is enabled for the repository.
-
channels(optional):
array channels
Channels associated with the repository.
-
contentTypes(optional):
array contentTypes
Content types associated with the repository.
-
createdBy(optional):
string
User that created the repository.
-
createdDate(optional):
createdDate
Date and time the repository was created.
-
defaultLanguage(optional):
string
Default language of the repository.
-
description(optional):
string
Human-readable description of the repository to give consumers an idea of what content this repository contains.
-
id(optional):
string
Unique identifier for the repository.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
languageOptions(optional):
array languageOptions
Language options for the repository.
-
name(optional):
string
Short human-readable name to identify the repository.
-
roleName(optional):
string
The role the authenticated user has within the repository.
Valid values are:
-
owner
- Owner of the resource -
custom
- Custom role -
manager
- Manager role -
contributor
- Contributor role -
downloader
- Downloader role -
viewer
- Viewer role
-
-
updatedBy(optional):
string
User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.
-
updatedDate(optional):
updatedDate
Date and time the repository was last updated.
Date and time the repository was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the repository was last updated.
-
object
DateTimeZone
Date, time and time zone.
object
Content type identifier.
-
name(optional):
string
Content type name.
requestType
A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Request-allOf[1]
object
-
approvers(optional):
object approvers
List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.
Introduced in release 19.3.3. -
createdAt(optional):
string(date-time)
Date and time the request was created. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
createdBy(optional):
createdBy
Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.
-
failure(optional):
object failure
If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.
-
id(optional):
string
Globally unique immutable identifier for a request.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
isDeleted(optional):
boolean
Indicates that the request is has been marked as soft deleted.
-
job(optional):
object job
When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is
blocked
- blocked waiting for approval. A completed request will also have a job status that iscompleted
. -
justification(optional):
string
Maximum Length:
1000
The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
-
lastModifiedAt(optional):
string(date-time)
Date and time the request was last updated. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
original(optional):
string
Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This forked request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.
-
policy(optional):
policy
Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.
Introduced in release 19.2.1. -
requestType(optional):
string
Type of Request. Valid values are:
SiteRequest
,CopySiteRequest
. -
reviews(optional):
object reviews
Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.
-
revision(optional):
integer(int64)
Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong
ETag
value for this resource. -
status(optional):
string
Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.
Valid values are:
-
pending
- Request is pending approval -
rejected
- Request has not been approved -
approved
- Request has been approved -
failed
- Request has been approved but failed during the request processing -
complete
- Request has been approved and is now complete
-
object
List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.
Introduced in release 19.3.3.-
items:
array items
Collection of Request Approvers Member elements.
Introduced in release 19.3.3.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.
object
If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.
object
When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is blocked
- blocked waiting for approval. A completed request will also have a job status that is completed
.
-
completed:
boolean
Whether the asynchronous job is completed or not.
-
completedPercentage(optional):
integer(int32)
A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.
-
context(optional):
string
Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.
-
endTime(optional):
string(date-time)
Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
error(optional):
object error
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
-
intervalToPoll(optional):
integer(int64)
A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
message(optional):
string
Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.
-
progress:
string
The current progress of the asynchronous job. These values indicate that the asynchronous job has ended:
succeeded
,failed
,aborted
. The valueblocked
means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are:pending
,processing
,paused
.Valid values are:
-
pending
- Request is waiting to run -
processing
- Request is running -
succeeded
- Request has completed successfully -
failed
- Request has failed
-
aborted
- Request was aborted
-
paused
- Request was running, but is now paused -
blocked
- Request is blocked
-
-
requestStatus(optional):
integer(int32)
HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.
-
result(optional):
result
It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the
requestStatus
property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource. -
startTime(optional):
string(date-time)
Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.
Introduced in release 19.2.1.-
allOf
Policy
A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.
A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.
A policy can be marked as inactive which prevents the operation from being performed or requested.
object
Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.
-
items:
array items
Collection of Review elements.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
array
Collection of Request Approvers Member elements.
Introduced in release 19.3.3.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.3.3. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.3.3. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.3.3. -
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.3.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.3.object
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus
property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.
-
object
HttpResponse
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.
A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.
A policy can be marked as inactive which prevents the operation from being performed or requested.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Policy-allOf[1]
object
-
access(optional):
object access
List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the
Introduced in release 19.3.1.accessType
of the policy is set torestricted
. -
accessType(optional):
string
Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.
Valid values are:
-
everyone
- Policy, when active, is applicable to everyone -
restricted
- Policy, when active, is applicable to users that are part of the access list
-
-
approvalType(optional):
string
When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.
Valid values are:
-
automatic
- A request will automatically be approved without any human approval process involved -
admin
- Any user with the site administrator role can approve the associated request -
named
- Site creation will require approval from one user that is a member of the approvers list associated with the policy
-
-
approvers(optional):
object approvers
List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.
Introduced in release 19.3.3. -
expiration(optional):
expiration
When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.
Introduced in release 19.4.1. -
id(optional):
string
Globally unique identifier for a policy.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
localizationPolicyAllowed(optional):
boolean
If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.
Introduced in release 19.2.3. -
repository(optional):
repository
When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.
Introduced in release 19.2.3. -
revision(optional):
integer(int64)
Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong
ETag
value for this resource. -
security(optional):
security
Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.
-
sitePrefixAllowed(optional):
boolean
If
Introduced in release 19.2.3.true
, a request for a new site can include an explicit site prefix. Iffalse
, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates. -
status(optional):
string
The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is inactive then the operation cannot be performed. If the policy status is active then the operation can be performed. For example, for a policy associated with a site template, a status of active means that users can create sites from that site template.
Valid values are:
-
inactive
- Policy that is marked as inactive means the associated operation cannot be requested -
active
- Policy that is marked as active means the associated operation can be requested
-
object
List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType
of the policy is set to restricted
.
-
items:
array items
Collection of Policy Access Member elements.
Introduced in release 19.3.1.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
object
List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.
Introduced in release 19.3.3.-
items:
array items
Collection of Policy Approvers Member elements.
Introduced in release 19.3.3.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.
Introduced in release 19.4.1.-
object
SiteExpirationPeriod
Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.
Introduced in release 19.4.1.
When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.
Introduced in release 19.2.3.-
allOf
Repository
Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.
A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.
Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.
-
object
SecurityPolicy
The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.
array
Collection of Policy Access Member elements.
Introduced in release 19.3.1.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.3.1. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.1. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.3.1. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.3.1. -
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.1.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.1.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.1.array
Collection of Policy Approvers Member elements.
Introduced in release 19.3.3.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.3.3. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.3.3. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.3.3. -
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.3.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.3.3.object
Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.
Introduced in release 19.4.1.-
amount(optional):
integer(int32)
Amount of time used to measure site expiration.
Introduced in release 19.4.1. -
unit(optional):
string
Unit of time used to measure site expiration.
Valid values are:
-
months
- Expiration expressed in the number of months -
years
- Expiration expressed in the number of years
-
object
The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.
-
appliesTo(optional):
string
Define which types of users may access a site. Can include all users or be restricted to named users only.
Valid values are:
-
named
- Only named users within a specified level can access -
all
- All users within a specified level can access
-
-
level(optional):
string
Maximum open security level that can be set on a site.
Valid values are:
-
service
- Only service users -
cloud
- Only cloud users who can sign in to your domain -
everyone
- Anyone without signing in
-
-
allOf
Review
A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.
A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Review-allOf[1]
object
-
comment(optional):
string
Maximum Length:
1000
A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
-
createdAt(optional):
string(date-time)
Date and time that the review was created. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
decision(optional):
string
Outcome of this review, either approve or reject the request.
Valid values are:
-
approved
- Associated request is approved -
rejected
- Associated request is rejected
-
-
id(optional):
integer(int32)
Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
reviewedBy(optional):
reviewedBy
Get the details of the user or client application that created the review.
Get the details of the user or client application that created the review.
object
Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only site administrators can change the security policy of a site.
-
access(optional):
array access
The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.
Valid values are:
-
named
- Selected named users -
service
- All service users -
visitors
- All service visitors -
cloud
- All cloud users who sign in to your domain -
everyone
- Anyone without signing in
-
-
policy(optional):
policy
The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.
array
The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.
Valid values are:
-
named
- Selected named users -
service
- All service users -
visitors
- All service visitors -
cloud
- All cloud users who sign in to your domain -
everyone
- Anyone without signing in
The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.
-
object
SecurityPolicy
The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.
object
Site page options.
For page specific options such as disable url validation check or enable server side rendering.
Introduced in release 23.2.1.-
ssrEnabled(optional):
boolean
Enable server side rendering (SSR) when delivering a site page.
* New in release 23.12.1. -
ssrReady(optional):
boolean
Whether it is ready to enable server side rendering (SSR) for delivering a site page.
* New in release 23.12.1. -
urlValidationDisabled(optional):
boolean
Disable the page url validation check that occurs when delivering a site page.
Introduced in release 23.2.1.
object
Static site delivery options.
For static sites i.e. compiled sites how long these sites are cached and what mobile user-agents call for adaptive mobile layouts supported by site compilation.
Introduced in release 20.3.3.-
cachingResponseHeaders(optional):
string
Maximum Length:
2000
Caching response headers. Additional headers which are added to a site's page to override the default caching headers. By default compiled sites are cached on a user's browser for 300 seconds (5 minutes). This can be overriden by entering a valid
Introduced in release 20.3.3.Cache-control
header. If Akamai is used anEdge-Control
header can be used to override the Akamai caching configuration. -
compileSite(optional):
boolean
Compile Site. Should the site be compiled for static site delivery.
Introduced in release 20.3.3. -
mobileUserAgents(optional):
string
Maximum Length:
2000
Mobile user agents. Comma separated list of user-agent substrings to specify the user agents to generate mobile pages for. When compiling a site, mobile pages can be created to support adaptive layouts. If any part of the substring matches the browser's user-agent string, then the mobile pages are served.
Introduced in release 20.3.3.
A theme defines the general look-and-feel and the overall style of a site, including color scheme, font size, font type, and page backgrounds. Themes provide visual consistency between the pages in the site. You adjust the design and add content to create a site that sells your style, your brand, and your vision.
Introduced in release 19.4.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Theme-allOf[1]
object
-
createdAt(optional):
string(date-time)
Date and time of creation. Date and time values are in ISO 8601
Introduced in release 19.4.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
createdBy(optional):
createdBy
User or client application that created this theme.
Introduced in release 19.4.1. -
description(optional):
string
Maximum Length:
1000
Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
Introduced in release 19.4.1. -
id(optional):
string
Immutable identifier for the theme.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.1. -
isDeleted(optional):
boolean
Indicates that the theme has been soft deleted. The corresponding theme folder will be in the trash folder of the user that owned the theme.
Introduced in release 19.4.1. -
isStarter(optional):
boolean
Indicates that the theme is a starter theme. Starter themes are copies of existing themes for the purpose of experimentation when developing new sites.
Introduced in release 22.8.1. -
job(optional):
job
Status for current job assigned to the theme.
Introduced in release 21.9.1. -
lastModifiedAt(optional):
string(date-time)
Date and time of the last modification. Date and time values are in ISO 8601
Introduced in release 19.4.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
lastModifiedBy(optional):
lastModifiedBy
User, client application or service that last modified this theme.
Introduced in release 19.4.1. -
members(optional):
object members
Users and groups the theme has been shared with.
Introduced in release 19.4.3. -
name(optional):
string
Maximum Length:
255
Human readable name for the theme.
Introduced in release 19.4.1. -
ownedBy(optional):
ownedBy
User or client application that owns this theme.
Introduced in release 19.4.1. -
permissions(optional):
object permissions
User permissions for the theme.
Introduced in release 22.7.2. -
publishStatus(optional):
string
Indicates whether the theme is published or not.
Valid values are:
-
unpublished
- Theme is unpublished -
published
- Theme is published
-
User or client application that created this theme.
Introduced in release 19.4.1.Status for current job assigned to the theme.
Introduced in release 21.9.1.-
allOf
SiteJobStatus
Discriminator:
action
Background job details for site jobs.
User, client application or service that last modified this theme.
Introduced in release 19.4.1.object
Users and groups the theme has been shared with.
Introduced in release 19.4.3.-
items:
array items
Collection of Theme Member elements.
Introduced in release 19.4.1.
-
allOf
CollectionResource
All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.
User or client application that owns this theme.
Introduced in release 19.4.1.object
User permissions for the theme.
Introduced in release 22.7.2.-
annotation(optional):
array annotation
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
-
-
conversation(optional):
array conversation
Set of conversation permissions the user has.
Valid values are:
-
read
- Read a conversation -
write
- Write to a conversation -
update
- Update a conversation -
delete
- Delete a conversation
-
-
file(optional):
array file
Set of file level permissions the user has.
Valid values are:
-
preview
- Preview file -
read
- Read file -
write
- Write to file -
update
- Update file -
delete
- Delete file
-
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
members(optional):
array members
Set of members permissions the user has.
Valid values are:
-
read
- Read and list members -
add
- Add to members -
update
- Update members -
remove
- Remove members
-
-
self(optional):
array self
Set of folder level permissions the user has.
Valid values are:
-
preview
- Preview folder -
read
- Read folder -
write
- Write to folder -
update
- Update folder -
delete
- Delete folder
-
- shareLink(optional): array shareLink
array
Collection of Theme Member elements.
Introduced in release 19.4.1.object
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.4.1. -
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1. -
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
-
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.1. -
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2. -
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.4.1. -
role:
string
Sharing role that the user, client application or group has been given.
Valid values are:
-
owner
- User is the owner -
manager
- User has Manager role -
contributor
- User has Contributor role -
downloader
- User has Downloader role -
viewer
- User has Viewer role
-
-
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
-
group
- Member is a group
-
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.1.
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1.User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.1.array
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
array
Set of conversation permissions the user has.
Valid values are:
-
read
- Read a conversation -
write
- Write to a conversation -
update
- Update a conversation -
delete
- Delete a conversation
array
Set of file level permissions the user has.
Valid values are:
-
preview
- Preview file -
read
- Read file -
write
- Write to file -
update
- Update file -
delete
- Delete file
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
array
Set of members permissions the user has.
Valid values are:
-
read
- Read and list members -
add
- Add to members -
update
- Update members -
remove
- Remove members
array
Set of folder level permissions the user has.
Valid values are:
-
preview
- Preview folder -
read
- Read folder -
write
- Write to folder -
update
- Update folder -
delete
- Delete folder
Site and site template thumbnail or preview image details.
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Image-allOf[1]
object
-
imageType(optional):
string
Image type.
Valid values are:
-
thumbnail
- Thumbnail representation of a site or template -
preview
- Preview image of what the site or template looks like
-
-
url(optional):
string(uri)
URL of this image.
array
Collection of Site Update elements.
Introduced in release 21.9.1.-
allOf
SiteUpdate
An update is a named collection of changes to the current base site. The changes remain in the update until you commit them and permanently update the base site.
Introduced in release 21.9.1.
An update is a named collection of changes to the current base site. The changes remain in the update until you commit them and permanently update the base site.
Introduced in release 21.9.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
SiteUpdate-allOf[1]
object
-
allowedActions(optional):
integer(int64)
Allowed user actions on the folder.
Introduced in release 22.7.2. -
createdAt(optional):
string(date-time)
Date and time of creation. Date and time values are in ISO 8601
Introduced in release 21.9.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
createdBy(optional):
createdBy
User or client application that created this resource.
Introduced in release 21.9.1. -
description(optional):
string
Maximum Length:
1000
Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
Introduced in release 21.9.1. -
id(optional):
string
Immutable identifier.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 21.9.1. -
isDeleted(optional):
boolean
Indicates that the item has been soft deleted.
Introduced in release 19.4.1. -
lastModifiedAt(optional):
string(date-time)
Date and time of the last modification. Date and time values are in ISO 8601
Introduced in release 21.9.1.yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
lastModifiedBy(optional):
lastModifiedBy
User or client application that last modified this resource.
Introduced in release 21.9.1. -
name(optional):
string
Maximum Length:
255
Human readable name for the site update.
Introduced in release 21.9.1. -
ownedBy(optional):
ownedBy
User or client application that owns this resource.
Introduced in release 21.9.1.
User or client application that created this resource.
Introduced in release 21.9.1.User or client application that last modified this resource.
Introduced in release 21.9.1.User or client application that owns this resource.
Introduced in release 21.9.1.object
Defines security settings relating to OCE user types, for instance whether the site should allow external users to be granted certain permissions
Introduced in release 21.10.2.-
externalUserEnabled(optional):
boolean
Indicates whether a site should allow external users. If true, the site will allow some (limited) privileges for external users, including (non-managing) member roles to be given to the such users.
Introduced in release 21.10.2.
Defines a vanity domain for a site. Once configured, a vanity domain may be used in place of the site domain to access the site.
Introduced in release 21.5.1.-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
VanityDomain-allOf[1]
object
-
configurationStatus(optional):
string
The configuration status of this vanity domain. The domain is not immediately available to users once set, configuration to make it available may take up to 60 mins to complete.
Valid values are:
-
processing
- Vanity domain configuration is in process -
completed
- Vanity domain configuration has completed -
failed
- Vanity domain configuration has failed
-
-
name(optional):
string
The vanity domain for this site.
Introduced in release 21.5.1.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Name Ambiguous",
"status":"404",
"detail":"Multiple sites exist with an identifier of '{site.id}'.",
"o:errorCode":"OCE-SITEMGMT-009090",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
},
"sites":[
{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0",
"name":"MyNewProduct",
"isExpired":false,
"isDeleted":false,
"description":"A folder for my assets.",
"createdAt":"2019-06-01T06:44:17.000Z",
"lastModifiedAt":"2019-06-01T06:44:17.000Z",
"thumbnail":{
"url":"http://cloud.example.com/images/site.png",
"imageType":"thumbnail"
},
"isEnterprise":false,
"themeName":"value",
"defaultLanguage":"en-US",
"runtimeStatus":"offline",
"offlineAt":"2019-06-01T06:44:17.000Z",
"onlineAt":"2019-06-01T06:44:17.000Z",
"publishStatus":"unpublished",
"publishedAt":"2019-06-01T06:44:17.000Z",
"unpublishedAt":"2019-06-01T06:44:17.000Z",
"expiresAt":"2019-06-01T06:44:17.000Z",
"security":{
"policy":{
"level":"service",
"appliesTo":"named"
},
"access":[
"named"
]
},
"userSecurity":{
"externalUserEnabled":false
},
"sitePrefix":"News",
"templateName":"value",
"isIframeEmbeddingAllowed":false,
"numberOfUpdates":1234,
"job":{
"action":"copy",
"context":"37D1070720325969AC6C47ACE8B9BFF91533560416423",
"startTime":"2018-05-21T12:01:15.123Z",
"endTime":"2018-05-21T12:01:15.123Z",
"progress":"pending",
"completed":false,
"requestStatus":200,
"message":"Running",
"completedPercentage":"50",
"intervalToPoll":"2000",
"error":{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Internal Error",
"status":"500",
"detail":"An internal error occurred.",
"o:errorCode":"ORA-999999"
},
"result":{
"status":{
"code":"200",
"reason":"OK"
},
"headers":[
{
"name":"Content-Type",
"value":"application/json"
}
]
}
},
"staticSiteDeliveryOptions":{
"compileSite":false,
"cachingResponseHeaders":"Cache-control: max-age=600",
"mobileUserAgents":"Mobile"
},
"compilationStatus":"value",
"sitePageOptions":{
"urlValidationDisabled":false,
"ssrEnabled":false,
"ssrReady":false
}
}
]
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Not Found",
"status":"404",
"detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
"o:errorCode":"OCE-SITEMGMT-009003",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}