Get Template Details
/sites/management/api/v1/templates/{id}
Read the template details given a template identifier. A template identifier is a globally unique value allocated to the template when the template is first created. This identifier can be discovered by listing templates with filters such as the template name.
Reading Templates with Site Governance On
A user can read any template that has been shared. When site governance is enabled site administrators can read any template regardless of whether the template has been shared with the site administrator. When site governance is enabled non site administrators can read templates that are associated with an authorized site creation policy regardless of whether the site has been shared with the user. A policy authorizes access to the template if the policy has an active status and the the policy access type is everyone. A policy authorizes access to the template if the policy has an active status and the policy access type is restricted and the authenticated user or client application is a member of the policy access list.
Path Alternative Identifiers
The default identifier for a Template resource is the Template Identifier. The Template resource supports alternative identifiers.
nameTemplate Name
Instead of the template identifier, the template name can be used to uniquely identify a template in the resource path. The default resource path parameter for a template is the template identifier, but when working with templates the human-readable template name is sometimes easier.
http://api.example.com/sites/management/api/v1/templates/name:CafeSupremo
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 Template Details
Returns the details of an enterprise site template, providing information such as the template name and description. Links are not included in the response.
Request
GET https://api.example.com/sites/management/api/v1/templates/{id}?links=none
Response Body
{ "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588036A", "name": "Marketing", "createdAt": "2019-05-12T16:33:28.000Z", "isEnterprise": true, "description": "Template for All Marketing Sites", "lastModifiedAt": "2019-05-19T11:24:45.000Z", "thumbnail": { "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F1E9A5A8892B83A63740A47F160AFA532D71F588036A&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559543608936", "imageType": "thumbnail" } }
200OK - Get Details of a Soft-Deleted Template
Returns the details of a soft-deleted template, providing information such as the template name and description. Soft deleted templates can be read only by the owner, or the user that soft deleted the template. Links are not included in the response.
Request
GET https://api.example.com/sites/management/api/v1/templates/{id}?includeDeleted=true&links=none
Response Body
{ "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588036A", "name": "Marketing", "createdAt": "2019-05-12T16:33:28.000Z", "isEnterprise": true, "isDeleted": true, "description": "Template for All Marketing Sites", "lastModifiedAt": "2019-05-19T11:24:45.000Z", "thumbnail": { "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F1E9A5A8892B83A63740A47F160AFA532D71F588036A&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559543608936", "imageType": "thumbnail" } }
200OK - Get the Details of a Template Including Permissions
Returns the details of a template with the authenticated user or client application template permissions. Links are not included in the response.
Request
GET https://api.example.com/sites/management/api/v1/templates/{id}?expand=permissions&links=none
Response Body
{ "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588036A", "name": "Marketing", "createdAt": "2019-05-12T16:33:28.000Z", "isEnterprise": true, "description": "Template for All Marketing Sites", "lastModifiedAt": "2019-05-19T11:24:45.000Z", "thumbnail": { "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F1E9A5A8892B83A63740A47F160AFA532D71F588036A&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559543608936", "imageType": "thumbnail" }, "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 - Template Name Ambiguous
The name provided does not uniquely identify a template. If a deleted template is referenced by name and there are multiple deleted templates with the same name this error will occur. This error provides details of the deleted templates with the same name.
Error Code
OCE-SITEMGMT-009088
Resolution - Use the Template Identifier
Use the unique template identifier instead of the name to identify the template.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
template | Template that does not exist or is not visible to the authenticated user. |
templates | Templates that match on name. |
For detailed information about this exception detail type, consult the TemplateNameAmbiguousExceptionDetail 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": "Template Name Ambiguous", "status": "404", "detail": "Multiple templates exist with an identifier of '{template.id}'.", "o:errorCode": "OCE-SITEMGMT-009088", "template": { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" }, "templates": [ { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6", "name": "CafeSupremo", "themeName": "value", "author": "value", "longDescription": "value", "defaultLanguage": "en-US", "isDeleted": false, "granularSecurity": { "enabled": false }, "createdAt": "2019-06-01T06:44:17.000Z", "isEnterprise": false, "description": "A folder for my assets.", "lastModifiedAt": "2019-06-01T06:44:17.000Z", "thumbnail": { "url": "http://cloud.example.com/images/site.png", "imageType": "thumbnail" } } ] }
Introduced in release 20.1.1.
404Not Found - Template Not Found
The site template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.
Error Code
OCE-SITEMGMT-009000
Resolution - Check Identifier
Check that the template identifier is valid.
Resolution - Check Membership
Check that the authenticated user is a member of the template or a site administrator.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
template | Template that does not exist or is not visible to the authenticated user. |
For detailed information about this exception detail type, consult the TemplateNotFoundExceptionDetail 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": "Template Not Found", "status": "404", "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.", "o:errorCode": "OCE-SITEMGMT-009000", "template": { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" } }
Request
-
id: string
Immutable identifier for the template.
-
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 template. createdBy
User or client application that created this template. lastModifiedBy
User, client application or service that last modified this template. theme
Theme associated with the template. localizationPolicy
Enterprise templates, when imported, create an associated localization policy. policy
When a policy is created, the policy is associated with a template. permissions
User permissions for the template. members
Users and groups the template has been shared with. -
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-template
Describes the undeletetemplate extended operation. hard-delete-template
Describes the harddeletetemplate extended operation. export-template
Describes the exporttemplate extended operation. template-copy
Describes the templatecopy extended operation. images
Describes the images child collection. template-components
Describes the template components child collection. template-assets
Describes the template assets child collection. template-asset-types
Describes the template asset types child collection. template-members
Describes the template members 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
Template
A site template provides a way of managing site creation with an associated approval policy. A site template can be in draft or available status, with only available templates offered to users that wish to create new sites. An approval policy associated with a site template defines how site requests created from the template are approved, such as requiring a site administrator to approve the request. Site templates have an associated thumbnail and image set that can be used to show a visual representation of the site that can be created. Site templates have a relationship to the physical template artifacts in the form of a site folder resource.
A site template provides a way of managing site creation with an associated approval policy. A site template can be in draft or available status, with only available templates offered to users that wish to create new sites. An approval policy associated with a site template defines how site requests created from the template are approved, such as requiring a site administrator to approve the request. Site templates have an associated thumbnail and image set that can be used to show a visual representation of the site that can be created. Site templates have a relationship to the physical template artifacts in the form of a site folder resource.
-
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
Template-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
-
author(optional):
string
A string identifier for the template's author
Introduced in release 21.8.2. -
createdAt(optional):
string(date-time)
When this template 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
User or client application that created this template.
-
defaultLanguage(optional):
string
The language code for the default language e.g. "en"
Introduced in release 21.8.2. -
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.
-
granularSecurity(optional):
granularSecurity
The granular security settings for the template.
Introduced in release 22.8.2. -
id(optional):
string
Immutable identifier for the template.
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 template has been soft deleted. The corresponding template folder will be in the trash folder of the user that owned the template.
Introduced in release 19.4.1. -
isEnterprise(optional):
boolean
Flag to indicate if this is an enterprise template
Introduced in release 19.2.3. -
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 template.
-
localizationPolicy(optional):
localizationPolicy
Enterprise templates, when imported, create an associated localization policy. This localization policy is then associated with the template. For standard templates there is no localization policy.
Introduced in release 19.2.3. -
longDescription(optional):
string
The details string aka long description of the template
Introduced in release 21.8.2. -
members(optional):
object members
Users and groups the template has been shared with.
Introduced in release 19.4.3. -
name(optional):
string
Maximum Length:
242
Human readable name for the template.
-
ownedBy(optional):
ownedBy
User or client application that owns this template.
-
permissions(optional):
object permissions
User permissions for the template.
Introduced in release 22.7.2. -
policy(optional):
policy
When a policy is created, the policy is associated with a template. If no policy is associated with a template no policy details will be available.
-
theme(optional):
theme
Theme associated with the template. When sites are created from the template the sites are also associated with the theme. 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.
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.
User or client application that created this template.
The granular security settings for the template.
Introduced in release 22.8.2.-
object
GranularSecurity
Defines the granular security settings.
Granular security restricts the actions an authenticated user or client application can perform on a resource.
Introduced in release 22.8.2.
User, client application or service that last modified this template.
Enterprise templates, when imported, create an associated localization policy. This localization policy is then associated with the template. For standard templates there is no localization policy.
Introduced in release 19.2.3.-
allOf
LocalizationPolicy
Localization policies are the translation rules applied to any text assets in a repository. These policies do not apply to digital assets such as images. That content is classified as non-translatable when it is uploaded. But content items can have multiple translated versions associated with the original item, which is considered the master copy.
When an item is localized, a copy of the item is made for the language. For example, there may be a blog post about the newest Android tablet that is translated into French and Spanish with the master copy in English. Each version of the blog post exists as a separate entity. It can be edited as needed and can be at a different stage of asset life cycle than the others. The French version could be in review, while the Spanish version could be published. There may be two or three content versions of the post, each of which can be translated and have a different status applied to it.
object
Users and groups the template has been shared with.
Introduced in release 19.4.3.-
items:
array items
Collection of Template 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 template.
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
When a policy is created, the policy is associated with a template. If no policy is associated with a template no policy details will be available.
-
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.
Theme associated with the template. When sites are created from the template the sites are also associated with the theme. 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.
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
object
Defines the granular security settings.
Granular security restricts the actions an authenticated user or client application can perform on a resource.
Introduced in release 22.8.2.-
enabled(optional):
boolean
Determines whether granular security is enabled for the resource.
Introduced in release 22.8.2.
Localization policies are the translation rules applied to any text assets in a repository. These policies do not apply to digital assets such as images. That content is classified as non-translatable when it is uploaded. But content items can have multiple translated versions associated with the original item, which is considered the master copy.
When an item is localized, a copy of the item is made for the language. For example, there may be a blog post about the newest Android tablet that is translated into French and Spanish with the master copy in English. Each version of the blog post exists as a separate entity. It can be edited as needed and can be at a different stage of asset life cycle than the others. The French version could be in review, while the Spanish version could be published. There may be two or three content versions of the post, each of which can be translated and have a different status applied to it.
-
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
LocalizationPolicy-allOf[1]
object
-
createdBy(optional):
string
User that created the policy.
-
createdDate(optional):
createdDate
Date and time the policy was created.
-
defaultValue(optional):
string
Fall back language in case if item of the given language not available. The default value will be one of the required languages.
-
description(optional):
string
Human-readable description of the repository to give consumers an idea of what content this localization policy is for.
-
id(optional):
string
Unique identifer for the localization policy.
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 localization policy.
-
optionalValues(optional):
array optionalValues
Optional language values.
-
requiredValues(optional):
array requiredValues
Required language values.
-
updatedBy(optional):
string
User that last updated the policy. If the policy has not been updated the updated by will be the user that created the policy.
-
updatedDate(optional):
updatedDate
Date and time the policy was last updated.
Date and time the policy was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the policy was last updated.
-
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.
array
Collection of Template Member elements.
Introduced in release 19.4.1.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.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.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
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
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
-
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
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.
object
Content type identifier.
-
name(optional):
string
Content type name.
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
-
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
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 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.
{
"id":"F1E9A5A8892B83A63740A47F160AFA532D71F588036A",
"name":"Marketing",
"createdAt":"2019-05-12T16:33:28.000Z",
"isEnterprise":true,
"description":"Template for All Marketing Sites",
"lastModifiedAt":"2019-05-19T11:24:45.000Z",
"thumbnail":{
"url":"https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F1E9A5A8892B83A63740A47F160AFA532D71F588036A&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559543608936",
"imageType":"thumbnail"
}
}
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
TemplateNameAmbiguousExceptionDetail
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
TemplateNameAmbiguousExceptionDetail-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
-
template(optional):
string
Template that does not exist or is not visible to the authenticated user.
Introduced in release 20.1.1. -
templates(optional):
array templates
Templates 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
Templates that match on name.
Introduced in release 20.1.1.-
allOf
Template
A site template provides a way of managing site creation with an associated approval policy. A site template can be in draft or available status, with only available templates offered to users that wish to create new sites. An approval policy associated with a site template defines how site requests created from the template are approved, such as requiring a site administrator to approve the request. Site templates have an associated thumbnail and image set that can be used to show a visual representation of the site that can be created. Site templates have a relationship to the physical template artifacts in the form of a site folder resource.
A site template provides a way of managing site creation with an associated approval policy. A site template can be in draft or available status, with only available templates offered to users that wish to create new sites. An approval policy associated with a site template defines how site requests created from the template are approved, such as requiring a site administrator to approve the request. Site templates have an associated thumbnail and image set that can be used to show a visual representation of the site that can be created. Site templates have a relationship to the physical template artifacts in the form of a site folder resource.
-
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
Template-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
-
author(optional):
string
A string identifier for the template's author
Introduced in release 21.8.2. -
createdAt(optional):
string(date-time)
When this template 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
User or client application that created this template.
-
defaultLanguage(optional):
string
The language code for the default language e.g. "en"
Introduced in release 21.8.2. -
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.
-
granularSecurity(optional):
granularSecurity
The granular security settings for the template.
Introduced in release 22.8.2. -
id(optional):
string
Immutable identifier for the template.
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 template has been soft deleted. The corresponding template folder will be in the trash folder of the user that owned the template.
Introduced in release 19.4.1. -
isEnterprise(optional):
boolean
Flag to indicate if this is an enterprise template
Introduced in release 19.2.3. -
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 template.
-
localizationPolicy(optional):
localizationPolicy
Enterprise templates, when imported, create an associated localization policy. This localization policy is then associated with the template. For standard templates there is no localization policy.
Introduced in release 19.2.3. -
longDescription(optional):
string
The details string aka long description of the template
Introduced in release 21.8.2. -
members(optional):
object members
Users and groups the template has been shared with.
Introduced in release 19.4.3. -
name(optional):
string
Maximum Length:
242
Human readable name for the template.
-
ownedBy(optional):
ownedBy
User or client application that owns this template.
-
permissions(optional):
object permissions
User permissions for the template.
Introduced in release 22.7.2. -
policy(optional):
policy
When a policy is created, the policy is associated with a template. If no policy is associated with a template no policy details will be available.
-
theme(optional):
theme
Theme associated with the template. When sites are created from the template the sites are also associated with the theme. 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.
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.
User or client application that created this template.
The granular security settings for the template.
Introduced in release 22.8.2.-
object
GranularSecurity
Defines the granular security settings.
Granular security restricts the actions an authenticated user or client application can perform on a resource.
Introduced in release 22.8.2.
User, client application or service that last modified this template.
Enterprise templates, when imported, create an associated localization policy. This localization policy is then associated with the template. For standard templates there is no localization policy.
Introduced in release 19.2.3.-
allOf
LocalizationPolicy
Localization policies are the translation rules applied to any text assets in a repository. These policies do not apply to digital assets such as images. That content is classified as non-translatable when it is uploaded. But content items can have multiple translated versions associated with the original item, which is considered the master copy.
When an item is localized, a copy of the item is made for the language. For example, there may be a blog post about the newest Android tablet that is translated into French and Spanish with the master copy in English. Each version of the blog post exists as a separate entity. It can be edited as needed and can be at a different stage of asset life cycle than the others. The French version could be in review, while the Spanish version could be published. There may be two or three content versions of the post, each of which can be translated and have a different status applied to it.
object
Users and groups the template has been shared with.
Introduced in release 19.4.3.-
items:
array items
Collection of Template 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 template.
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
When a policy is created, the policy is associated with a template. If no policy is associated with a template no policy details will be available.
-
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.
Theme associated with the template. When sites are created from the template the sites are also associated with the theme. 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.
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
object
Defines the granular security settings.
Granular security restricts the actions an authenticated user or client application can perform on a resource.
Introduced in release 22.8.2.-
enabled(optional):
boolean
Determines whether granular security is enabled for the resource.
Introduced in release 22.8.2.
Localization policies are the translation rules applied to any text assets in a repository. These policies do not apply to digital assets such as images. That content is classified as non-translatable when it is uploaded. But content items can have multiple translated versions associated with the original item, which is considered the master copy.
When an item is localized, a copy of the item is made for the language. For example, there may be a blog post about the newest Android tablet that is translated into French and Spanish with the master copy in English. Each version of the blog post exists as a separate entity. It can be edited as needed and can be at a different stage of asset life cycle than the others. The French version could be in review, while the Spanish version could be published. There may be two or three content versions of the post, each of which can be translated and have a different status applied to it.
-
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
LocalizationPolicy-allOf[1]
object
-
createdBy(optional):
string
User that created the policy.
-
createdDate(optional):
createdDate
Date and time the policy was created.
-
defaultValue(optional):
string
Fall back language in case if item of the given language not available. The default value will be one of the required languages.
-
description(optional):
string
Human-readable description of the repository to give consumers an idea of what content this localization policy is for.
-
id(optional):
string
Unique identifer for the localization policy.
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 localization policy.
-
optionalValues(optional):
array optionalValues
Optional language values.
-
requiredValues(optional):
array requiredValues
Required language values.
-
updatedBy(optional):
string
User that last updated the policy. If the policy has not been updated the updated by will be the user that created the policy.
-
updatedDate(optional):
updatedDate
Date and time the policy was last updated.
Date and time the policy was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the policy was last updated.
-
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.
array
Collection of Template Member elements.
Introduced in release 19.4.1.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.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.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
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
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
-
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
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.
object
Content type identifier.
-
name(optional):
string
Content type name.
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
-
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
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 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.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Template Name Ambiguous",
"status":"404",
"detail":"Multiple templates exist with an identifier of '{template.id}'.",
"o:errorCode":"OCE-SITEMGMT-009088",
"template":{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
},
"templates":[
{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6",
"name":"CafeSupremo",
"themeName":"value",
"author":"value",
"longDescription":"value",
"defaultLanguage":"en-US",
"isDeleted":false,
"granularSecurity":{
"enabled":false
},
"createdAt":"2019-06-01T06:44:17.000Z",
"isEnterprise":false,
"description":"A folder for my assets.",
"lastModifiedAt":"2019-06-01T06:44:17.000Z",
"thumbnail":{
"url":"http://cloud.example.com/images/site.png",
"imageType":"thumbnail"
}
}
]
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Template Not Found",
"status":"404",
"detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
"o:errorCode":"OCE-SITEMGMT-009000",
"template":{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
}
}