Get the Running Job Associated with the Theme
/sites/management/api/v1/themes/{id}/job
Status for current job assigned to the theme.
Introduced in release 21.9.1.
Authorization
To invoke this operation, the authenticated user or client application must have been shared with the resource and have one of the following sharing roles:
- Owner
- Manager
- Contributor
- Downloader
- Viewer
Path Alternative Identifiers
The default identifier for a Theme resource is the Theme Identifier. The Theme resource supports alternative identifiers.
nameTheme Name
Instead of the theme identifier, the theme name can be used to uniquely identify a theme in the resource path. The default resource path parameter for a theme is the theme identifier, but when working with themes the human-readable theme name is sometimes easier.
http://api.example.com/sites/management/api/v1/themes/name:LearnTheme/job
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 - Copy Site Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "copy", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }
200OK - Publish Site Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "publish", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }
200OK - Translate Site Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "translate", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }
200OK - Refresh Site Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "refresh", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] }, "trigger": "api", "pageCount": "13", "pendingCount": "5", "processingCount": "3", "completedCount": "5", "failedCount": "0" }
200OK - Import Translations Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "importTranslations", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] }, "valid": false, "sourceLanguage": "en-US", "targetLanguages": [ "en-US" ], "importedAssetTranslations": [ { "id": "COREE7DE9D503B88485999D6971066A3BE90", "name": "Maximum_Article", "type": "value", "description": "value", "slug": "value", "isPublished": false, "repositoryId": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "channels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] }, "publishedChannels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] } } ], "importedSiteTranslations": [ { "fileName": "130.json", "page": { "id": "130", "name": "Navigation", "parentId": 1234, "pageUrl": "value", "hideInNavigation": false, "linkUrl": "value", "linkTarget": "value", "children": [ 1234 ], "overrideUrl": false, "isDetailPage": false, "isSearchPage": false } } ], "assetValidation": { "valid": false, "languagesNotReturned": [ "en-US" ], "languagesReturnedComplete": [ "en-US" ], "languagesReturnedIncomplete": [ "en-US" ], "translationsMissed": [ { "language": "en-US", "items": [ { "id": "COREE7DE9D503B88485999D6971066A3BE90", "name": "Maximum_Article", "type": "value", "description": "value", "slug": "value", "isPublished": false, "repositoryId": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "channels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] }, "publishedChannels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] } } ] } ], "translationsCorrupted": [ { "language": "en-US", "items": [ { "id": "COREE7DE9D503B88485999D6971066A3BE90", "name": "Maximum_Article", "type": "value", "description": "value", "slug": "value", "isPublished": false, "repositoryId": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "channels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] }, "publishedChannels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] } } ] } ], "translationsInvalidEncoding": [ { "language": "en-US", "items": [ { "id": "COREE7DE9D503B88485999D6971066A3BE90", "name": "Maximum_Article", "type": "value", "description": "value", "slug": "value", "isPublished": false, "repositoryId": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "channels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] }, "publishedChannels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] } } ] } ], "itemsToBeImported": [ { "id": "COREE7DE9D503B88485999D6971066A3BE90", "name": "Maximum_Article", "type": "value", "description": "value", "slug": "value", "isPublished": false, "repositoryId": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "channels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] }, "publishedChannels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] } } ], "nonTranslatableItems": [ { "id": "COREE7DE9D503B88485999D6971066A3BE90", "name": "Maximum_Article", "type": "value", "description": "value", "slug": "value", "isPublished": false, "repositoryId": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "channels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] }, "publishedChannels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] } } ], "deletedMasterItems": [ { "id": "COREE7DE9D503B88485999D6971066A3BE90", "name": "Maximum_Article", "type": "value", "description": "value", "slug": "value", "isPublished": false, "repositoryId": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "channels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] }, "publishedChannels": { "data": [ { "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC", "name": "AcmeProductLaunch" } ] } } ] }, "siteValidation": { "valid": false, "languagesNotReturned": [ "en-US" ], "languagesReturnedComplete": [ "en-US" ], "languagesReturnedIncomplete": [ "en-US" ], "translationsMissed": [ { "language": "en-US", "items": [ { "fileName": "130.json", "page": { "id": "130", "name": "Navigation", "parentId": 1234, "pageUrl": "value", "hideInNavigation": false, "linkUrl": "value", "linkTarget": "value", "children": [ 1234 ], "overrideUrl": false, "isDetailPage": false, "isSearchPage": false } } ] } ], "translationsCorrupted": [ { "language": "en-US", "items": [ { "fileName": "130.json", "page": { "id": "130", "name": "Navigation", "parentId": 1234, "pageUrl": "value", "hideInNavigation": false, "linkUrl": "value", "linkTarget": "value", "children": [ 1234 ], "overrideUrl": false, "isDetailPage": false, "isSearchPage": false } } ] } ], "translationsInvalidEncoding": [ { "language": "en-US", "items": [ { "fileName": "130.json", "page": { "id": "130", "name": "Navigation", "parentId": 1234, "pageUrl": "value", "hideInNavigation": false, "linkUrl": "value", "linkTarget": "value", "children": [ 1234 ], "overrideUrl": false, "isDetailPage": false, "isSearchPage": false } } ] } ], "deletedPages": [ "value" ], "itemsToBeImported": [ { "fileName": "130.json", "page": { "id": "130", "name": "Navigation", "parentId": 1234, "pageUrl": "value", "hideInNavigation": false, "linkUrl": "value", "linkTarget": "value", "children": [ 1234 ], "overrideUrl": false, "isDetailPage": false, "isSearchPage": false } } ] }, "validationOnly": false }
200OK - Async Site Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }
200OK - Publish Theme Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "publishTheme", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }
200OK - Copy Theme Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "copyTheme", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }
200OK - Hard Delete Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "hardDelete", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }
200OK - Copy Component Job Status
Request
GET https://api.example.com/sites/management/api/v1/themes/{id}/job
Response Body
{ "action": "copyComponent", "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423", "startTime": "2018-05-21T12:01:15.123Z", "endTime": "2018-05-21T12:01:15.123Z", "progress": "pending", "completed": false, "requestStatus": 200, "message": "Running", "completedPercentage": "50", "intervalToPoll": "2000", "error": { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Internal Error", "status": "500", "detail": "An internal error occurred.", "o:errorCode": "ORA-999999" }, "result": { "status": { "code": "200", "reason": "OK" }, "headers": [ { "name": "Content-Type", "value": "application/json" } ] } }
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 - Theme Name Ambiguous
The name provided does not uniquely identify a theme. If a deleted theme is referenced by name and there are multiple themes with the same name this error will occur. This error provides details of the deleted themes with the same name.
Error Code
OCE-SITEMGMT-009087
Resolution - Use the Theme Identifier
Use the unique theme identifier instead of the name to identify the theme.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
theme | Theme that does not exist or is not visible to the authenticated user. |
themes | Themes that match on name. |
For detailed information about this exception detail type, consult the ThemeNameAmbiguousExceptionDetail 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": "Theme Name Ambiguous", "status": "404", "detail": "Multiple themes exist with an identifier of '{theme.id}'.", "o:errorCode": "OCE-SITEMGMT-009087", "theme": { "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC" }, "themes": [ { "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC", "name": "CafeSupremoTheme", "isDeleted": false, "description": "A folder for my assets.", "createdAt": "2019-06-01T06:44:17.000Z", "lastModifiedAt": "2019-06-01T06:44:17.000Z", "publishStatus": "unpublished", "isStarter": false } ] }
Introduced in release 20.1.1.
404Not Found - Theme Not Found
The site theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.
Error Code
OCE-SITEMGMT-009041
Resolution - Check Identifier
Check that the theme identifier is valid.
Resolution - Check Membership
Check that the authenticated user is a member of the theme.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
theme | Theme that does not exist or is not visible to the authenticated user. |
For detailed information about this exception detail type, consult the ThemeNotFoundExceptionDetail 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": "Theme Not Found", "status": "404", "detail": "Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.", "o:errorCode": "OCE-SITEMGMT-009041", "theme": { "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC" } }
Introduced in release 19.4.1.
404Not Found - Relationship Not Found
An attempt to read a relationship has failed because the relationship does not exist. Reading a relationship can fail if the relationship no longer exists or the authenticated identity is not authorized to read the relationship details.
Error Code
PAAS-005027
Example Response Body
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Relationship Not Found", "status": "404", "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.", "o:errorCode": "PAAS-005027" }
This resource represents the relationship between a Theme and Site Job Status resource. If there is no Site Job Status associated with the Theme then the response status code will be 204 No Content. If the Site Job Status has been deleted or the authenticated user is not authorized to read the resource then the response status code will be 404 Not Found and a Relationship Not Found error will be returned in the response body.
Request
-
id: string
Immutable identifier for the theme.
-
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 site
The site that was created by the completed site creation job. translationFile
The details of the translation file. translationJob
The details of the translation job. pages
List of all pages that are included in the site refresh job. translationImportFile
The file containing the site translations to import. theme
The copied theme for completed copy job. component
The copied component for completed copy job. -
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. 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
SiteJobStatus
Discriminator:
action
Background job details for site jobs.
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
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
-
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.
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
object
REST HATEOAS link and related metadata. If responses provide links (for example, a self
link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
-
href(optional):
string
The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the
templated
property must be set totrue
. -
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
Valid values are:
-
OPTIONS
- HTTP OPTIONS -
HEAD
- HTTP HEAD -
GET
- HTTP GET -
POST
- HTTP POST -
PUT
- HTTP PUT -
PATCH
- HTTP PATCH -
DELETE
- HTTP DELETE
-
-
profile(optional):
string(uri)
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Boolean flag that specifies the
href
property is a URI or URI Template. The property can be assumed to befalse
if the property is not present.
object
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.
{
"action":"copy",
"context":"37D1070720325969AC6C47ACE8B9BFF91533560416423",
"startTime":"2018-05-21T12:01:15.123Z",
"endTime":"2018-05-21T12:01:15.123Z",
"progress":"pending",
"completed":false,
"requestStatus":200,
"message":"Running",
"completedPercentage":"50",
"intervalToPoll":"2000",
"error":{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Internal Error",
"status":"500",
"detail":"An internal error occurred.",
"o:errorCode":"ORA-999999"
},
"result":{
"status":{
"code":"200",
"reason":"OK"
},
"headers":[
{
"name":"Content-Type",
"value":"application/json"
}
]
}
}
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
ThemeNameAmbiguousExceptionDetail
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
ThemeNameAmbiguousExceptionDetail-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
-
theme(optional):
string
Theme that does not exist or is not visible to the authenticated user.
Introduced in release 20.1.1. -
themes(optional):
array themes
Themes 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
Themes that match on name.
Introduced in release 20.1.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.
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
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
-
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
-
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 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
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
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.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
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Theme Name Ambiguous",
"status":"404",
"detail":"Multiple themes exist with an identifier of '{theme.id}'.",
"o:errorCode":"OCE-SITEMGMT-009087",
"theme":{
"id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
},
"themes":[
{
"id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC",
"name":"CafeSupremoTheme",
"isDeleted":false,
"description":"A folder for my assets.",
"createdAt":"2019-06-01T06:44:17.000Z",
"lastModifiedAt":"2019-06-01T06:44:17.000Z",
"publishStatus":"unpublished",
"isStarter":false
}
]
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Theme Not Found",
"status":"404",
"detail":"Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.",
"o:errorCode":"OCE-SITEMGMT-009041",
"theme":{
"id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Relationship Not Found",
"status":"404",
"detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
"o:errorCode":"PAAS-005027"
}