Root Schema : schema
Match All
Show Source
-
allOf
Site
A site includes information about the original request for the site, such as who requested and who approved the site as well as details about the physical site, in the form of a site folder. All sites created through requests using the approval process will have a reference to the request that was used to created them, but sites created directly will not have request details.
{
"allOf":[
{
"$ref":"#/definitions/Site"
}
]
}
Nested Schema : Site
A site includes information about the original request for the site, such as who requested and who approved the site as well as details about the physical site, in the form of a site folder. All sites created through requests using the approval process will have a reference to the request that was used to created them, but sites created directly will not have request details.
Match All
Show Source
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Site-allOf[1]
{
"description":"<p>A site includes information about the original request for the site, such as who requested and who approved the site as well as details about the physical site, in the form of a site folder. All sites created through requests using the approval process will have a reference to the request that was used to created them, but sites created directly will not have request details.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Immutable identifier for the site.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Human readable name for the site. </p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":242
},
"ownedBy":{
"description":"<p>User or client application that owns this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"createdBy":{
"description":"<p>User or client application that created this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"lastModifiedBy":{
"description":"<p>User, client application or service that last modified this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"theme":{
"description":"<p>Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Theme"
}
]
},
"request":{
"description":"<p>Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Request"
}
]
},
"members":{
"description":"<p>Users and groups the site has been shared with.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"access":{
"description":"<p>Users and groups that can access the site.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"permissions":{
"description":"<p>User permissions for the site.</p><small>Introduced in release 22.7.2.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"self":{
"description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"file":{
"description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"members":{
"description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"shareLink":{
"description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"annotation":{
"description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"conversation":{
"description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
},
"vanityDomain":{
"description":"<p>Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.</p><small>Introduced in release 21.5.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/VanityDomain"
}
]
},
"updates":{
"description":"<p>Updates for the site.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/SiteUpdate"
}
]
}
}
},
"required":[
"items"
]
},
"isExpired":{
"description":"<p>If a site has an expiration date then an expired indicator will also be available. If a site does not have an expiration date then this field will not be present.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"isDeleted":{
"description":"<p>Indicates that the site has been soft deleted. The corresponding site folder will be in the trash folder of the user that owned the site.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"description":{
"description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"createdAt":{
"description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"lastModifiedAt":{
"description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"thumbnail":{
"description":"<p>Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/Image"
}
]
},
"isEnterprise":{
"description":"<p>Is this an Enterprise site.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"themeName":{
"description":"<p>Name of the theme used by this template.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"defaultLanguage":{
"description":"<p>Default language for translation.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"runtimeStatus":{
"description":"<p>Indicates whether the site is offline or online.</p><p>Valid values are:\n<ul><li> <code>offline</code> - Site is offline. Site has not been activated, or was activated and was deactivated</li><li> <code>online</code> - Site is online. Site has been activated</li></p><small>Introduced in release 19.2.2.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"offlineAt":{
"description":"<p>When the site was last taken offline. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"onlineAt":{
"description":"<p>When the site was last brought online. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.2.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"publishStatus":{
"description":"<p>Indicates what state the site is in with respect to site artifact publication.</p><p>Valid values are:\n<ul><li> <code>unpublished</code> - Site is unpublished. No published files on runtime site environment</li><li> <code>draft</code> - Site has draft updates. Published files exist on runtime site environment, but there are new unapproved updates in base site</li><li> <code>approved</code> - Site has approved updates. Published files exist on runtime site environment, but there are new approved updates in base site</li><li> <code>published</code> - Site is published. Published files exist on runtime site environment</li></p><small>Introduced in release 19.2.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"publishedAt":{
"description":"<p>When the site was last published. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"unpublishedAt":{
"description":"<p>When the site was last unpublished. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.2.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"expiresAt":{
"description":"<p>Expiration date for the site, if the site has been given an expiration date. An expired site cannot be activated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"security":{
"description":"<p>Site security settings.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteSecurity"
}
]
},
"userSecurity":{
"description":"<p>Site security settings relating to OCE user types.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteUserSecurity"
}
]
},
"sitePrefix":{
"description":"<p>The site prefix is used to prefix content item names that appear in a URL if the content item does not have a slug prefix. Specifying a site prefix ensures all content items for the site have a unique slug. Site prefixes are limit to 15 characters in length.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":15
},
"templateName":{
"description":"<p>Name of the template that was used to create this site.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isIframeEmbeddingAllowed":{
"description":"<p>Whether this site can be embedded in an iFrame.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"numberOfUpdates":{
"description":"<p>Number of updates made on this site.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"job":{
"description":"<p>Running job details for the site. If there is a job running for the site the details will be returned.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
},
"repository":{
"description":"<p>The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
},
"channel":{
"description":"<p>The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Channel"
}
]
},
"defaultCollection":{
"description":"<p>When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/RepositoryCollection"
}
]
},
"staticSiteDeliveryOptions":{
"description":"<p>Static site options.</p><small>Introduced in release 20.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/StaticSiteDeliveryOptions"
}
]
},
"contentSecurity":{
"description":"<p>Content security assigned to the site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/TaxonomyCategory"
}
]
},
"siteCategory":{
"description":"<p>Private site category generated for SST sites.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/TaxonomyCategory"
}
]
},
"compilationStatus":{
"description":"<p>The compilation status of the site. This can either be a custom value or one of the several know statuses e.g <code>Submitted</code>, <code>Compiled</code> and <code>Failed</code>.</p><small>Introduced in release 23.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"sitePageOptions":{
"description":"<p>Site page options.</p><small>Introduced in release 23.2.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SitePageOptions"
}
]
}
}
}
]
}
Nested Schema : SingularResource
Type: 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.
Show Source
-
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.
{
"description":"<p>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 <em>self</em> link the resource itself.</p>",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
}
}
}
Nested Schema : Site-allOf[1]
Type: object
Show Source
-
access(optional):
object access
Users and groups that can access the site.
Introduced in release 19.4.3.
-
channel(optional):
channel
The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.
Introduced in release 19.2.3.
-
compilationStatus(optional):
string
The compilation status of the site. This can either be a custom value or one of the several know statuses e.g Submitted
, Compiled
and Failed
.
Introduced in release 23.1.1.
-
contentSecurity(optional):
contentSecurity
Content security assigned to the site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
createdAt(optional):
string(date-time)
Date and time of creation. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
-
createdBy(optional):
createdBy
User or client application that created this site.
-
defaultCollection(optional):
defaultCollection
When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.
Introduced in release 19.2.3.
-
defaultLanguage(optional):
string
Default language for translation.
-
description(optional):
string
Maximum Length: 1000
Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
-
expiresAt(optional):
string(date-time)
Expiration date for the site, if the site has been given an expiration date. An expired site cannot be activated. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Introduced in release 19.4.1.
-
id(optional):
string
Immutable identifier for the site.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
isDeleted(optional):
boolean
Indicates that the site has been soft deleted. The corresponding site folder will be in the trash folder of the user that owned the site.
Introduced in release 19.4.1.
-
isEnterprise(optional):
boolean
Is this an Enterprise site.
-
isExpired(optional):
boolean
If a site has an expiration date then an expired indicator will also be available. If a site does not have an expiration date then this field will not be present.
Introduced in release 19.4.1.
-
isIframeEmbeddingAllowed(optional):
boolean
Whether this site can be embedded in an iFrame.
-
job(optional):
job
Running job details for the site. If there is a job running for the site the details will be returned.
-
lastModifiedAt(optional):
string(date-time)
Date and time of the last modification. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
-
lastModifiedBy(optional):
lastModifiedBy
User, client application or service that last modified this site.
-
members(optional):
object members
Users and groups the site has been shared with.
Introduced in release 19.4.3.
-
name(optional):
string
Maximum Length: 242
Human readable name for the site.
-
numberOfUpdates(optional):
integer(int32)
Number of updates made on this site.
-
offlineAt(optional):
string(date-time)
When the site was last taken offline. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
-
onlineAt(optional):
string(date-time)
When the site was last brought online. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Introduced in release 19.2.2.
-
ownedBy(optional):
ownedBy
User or client application that owns this site.
-
permissions(optional):
object permissions
User permissions for the site.
Introduced in release 22.7.2.
-
publishedAt(optional):
string(date-time)
When the site was last published. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
-
publishStatus(optional):
string
Indicates what state the site is in with respect to site artifact publication.
Valid values are:
-
unpublished
- Site is unpublished. No published files on runtime site environment -
draft
- Site has draft updates. Published files exist on runtime site environment, but there are new unapproved updates in base site -
approved
- Site has approved updates. Published files exist on runtime site environment, but there are new approved updates in base site -
published
- Site is published. Published files exist on runtime site environment
Introduced in release 19.2.2.
-
repository(optional):
repository
The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.
Introduced in release 19.2.3.
-
request(optional):
request
Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.
-
runtimeStatus(optional):
string
Indicates whether the site is offline or online.
Valid values are:
-
offline
- Site is offline. Site has not been activated, or was activated and was deactivated -
online
- Site is online. Site has been activated
Introduced in release 19.2.2.
-
security(optional):
security
-
siteCategory(optional):
siteCategory
Private site category generated for SST sites.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
sitePageOptions(optional):
sitePageOptions
Site page options.
Introduced in release 23.2.1.
-
sitePrefix(optional):
string
Maximum Length: 15
The site prefix is used to prefix content item names that appear in a URL if the content item does not have a slug prefix. Specifying a site prefix ensures all content items for the site have a unique slug. Site prefixes are limit to 15 characters in length.
Introduced in release 19.2.3.
-
staticSiteDeliveryOptions(optional):
staticSiteDeliveryOptions
Static site options.
Introduced in release 20.3.3.
-
templateName(optional):
string
Name of the template that was used to create this site.
-
theme(optional):
theme
Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.
Introduced in release 19.4.1.
-
themeName(optional):
string
Name of the theme used by this template.
-
thumbnail(optional):
thumbnail
Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.
-
unpublishedAt(optional):
string(date-time)
When the site was last unpublished. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Introduced in release 19.2.2.
-
updates(optional):
object updates
Updates for the site.
Introduced in release 21.9.1.
-
userSecurity(optional):
userSecurity
Site security settings relating to OCE user types.
Introduced in release 21.10.2.
-
vanityDomain(optional):
vanityDomain
Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.
Introduced in release 21.5.1.
{
"properties":{
"id":{
"description":"<p>Immutable identifier for the site.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Human readable name for the site. </p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":242
},
"ownedBy":{
"description":"<p>User or client application that owns this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"createdBy":{
"description":"<p>User or client application that created this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"lastModifiedBy":{
"description":"<p>User, client application or service that last modified this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"theme":{
"description":"<p>Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Theme"
}
]
},
"request":{
"description":"<p>Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Request"
}
]
},
"members":{
"description":"<p>Users and groups the site has been shared with.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"access":{
"description":"<p>Users and groups that can access the site.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"permissions":{
"description":"<p>User permissions for the site.</p><small>Introduced in release 22.7.2.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"self":{
"description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"file":{
"description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"members":{
"description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"shareLink":{
"description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"annotation":{
"description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"conversation":{
"description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
},
"vanityDomain":{
"description":"<p>Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.</p><small>Introduced in release 21.5.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/VanityDomain"
}
]
},
"updates":{
"description":"<p>Updates for the site.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/SiteUpdate"
}
]
}
}
},
"required":[
"items"
]
},
"isExpired":{
"description":"<p>If a site has an expiration date then an expired indicator will also be available. If a site does not have an expiration date then this field will not be present.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"isDeleted":{
"description":"<p>Indicates that the site has been soft deleted. The corresponding site folder will be in the trash folder of the user that owned the site.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"description":{
"description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"createdAt":{
"description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"lastModifiedAt":{
"description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"thumbnail":{
"description":"<p>Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/Image"
}
]
},
"isEnterprise":{
"description":"<p>Is this an Enterprise site.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"themeName":{
"description":"<p>Name of the theme used by this template.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"defaultLanguage":{
"description":"<p>Default language for translation.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"runtimeStatus":{
"description":"<p>Indicates whether the site is offline or online.</p><p>Valid values are:\n<ul><li> <code>offline</code> - Site is offline. Site has not been activated, or was activated and was deactivated</li><li> <code>online</code> - Site is online. Site has been activated</li></p><small>Introduced in release 19.2.2.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"offlineAt":{
"description":"<p>When the site was last taken offline. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"onlineAt":{
"description":"<p>When the site was last brought online. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.2.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"publishStatus":{
"description":"<p>Indicates what state the site is in with respect to site artifact publication.</p><p>Valid values are:\n<ul><li> <code>unpublished</code> - Site is unpublished. No published files on runtime site environment</li><li> <code>draft</code> - Site has draft updates. Published files exist on runtime site environment, but there are new unapproved updates in base site</li><li> <code>approved</code> - Site has approved updates. Published files exist on runtime site environment, but there are new approved updates in base site</li><li> <code>published</code> - Site is published. Published files exist on runtime site environment</li></p><small>Introduced in release 19.2.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"publishedAt":{
"description":"<p>When the site was last published. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"unpublishedAt":{
"description":"<p>When the site was last unpublished. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.2.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"expiresAt":{
"description":"<p>Expiration date for the site, if the site has been given an expiration date. An expired site cannot be activated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"security":{
"description":"<p>Site security settings.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteSecurity"
}
]
},
"userSecurity":{
"description":"<p>Site security settings relating to OCE user types.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteUserSecurity"
}
]
},
"sitePrefix":{
"description":"<p>The site prefix is used to prefix content item names that appear in a URL if the content item does not have a slug prefix. Specifying a site prefix ensures all content items for the site have a unique slug. Site prefixes are limit to 15 characters in length.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":15
},
"templateName":{
"description":"<p>Name of the template that was used to create this site.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isIframeEmbeddingAllowed":{
"description":"<p>Whether this site can be embedded in an iFrame.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"numberOfUpdates":{
"description":"<p>Number of updates made on this site.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"job":{
"description":"<p>Running job details for the site. If there is a job running for the site the details will be returned.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
},
"repository":{
"description":"<p>The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
},
"channel":{
"description":"<p>The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Channel"
}
]
},
"defaultCollection":{
"description":"<p>When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/RepositoryCollection"
}
]
},
"staticSiteDeliveryOptions":{
"description":"<p>Static site options.</p><small>Introduced in release 20.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/StaticSiteDeliveryOptions"
}
]
},
"contentSecurity":{
"description":"<p>Content security assigned to the site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/TaxonomyCategory"
}
]
},
"siteCategory":{
"description":"<p>Private site category generated for SST sites.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/TaxonomyCategory"
}
]
},
"compilationStatus":{
"description":"<p>The compilation status of the site. This can either be a custom value or one of the several know statuses e.g <code>Submitted</code>, <code>Compiled</code> and <code>Failed</code>.</p><small>Introduced in release 23.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"sitePageOptions":{
"description":"<p>Site page options.</p><small>Introduced in release 23.2.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SitePageOptions"
}
]
}
}
}
Nested Schema : links
Type: 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.
Show Source
{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
}
Nested Schema : items
Match All
Show Source
-
object
Link
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.
{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
Nested Schema : Link
Type: 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.
Show Source
-
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 to true
.
-
mediaType(optional):
string
-
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 be false
if the property is not present.
{
"description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
"properties":{
"rel":{
"description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"href":{
"description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"templated":{
"description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"mediaType":{
"description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"method":{
"description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"profile":{
"description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"uri"
}
}
}
Nested Schema : access
Type: object
Users and groups that can access the site.
Introduced in release 19.4.3.
Show Source
-
items:
array items
Collection of Site Access Member elements.
Introduced in release 19.4.3.
{
"description":"<p>Users and groups that can access the site.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Match All
Show Source
-
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.
{
"description":"<p>Users and groups that can access the site.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Nested Schema : channel
The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.
Introduced in release 19.2.3.
Match All
Show Source
-
allOf
Channel
A publishing channel determines the release rules that are applied to an item in a repository. A channel can be public and available to everyone, or secure and limited. A repository can use multiple channels. You can select specific channels to use with specific assets in the repository, letting you decide the policies to be applied in individual cases.
{
"description":"<p>The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Channel"
}
]
}
Nested Schema : contentSecurity
Content security assigned to the site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
Match All
Show Source
-
allOf
TaxonomyCategory
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
{
"description":"<p>Content security assigned to the site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/TaxonomyCategory"
}
]
}
Nested Schema : createdBy
User or client application that created this site.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application that created this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : defaultCollection
When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.
Introduced in release 19.2.3.
Match All
Show Source
-
allOf
RepositoryCollection
Collections are a way to group content items, digital assets, and documents for use on a website, external application or for marketing campaigns. Collections are specific to individual repositories and can be used to manage a subset of items in a repository. All the items in the collection will adhere to the publishing channel that is assigned to the collection.
{
"description":"<p>When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/RepositoryCollection"
}
]
}
Nested Schema : job
Running job details for the site. If there is a job running for the site the details will be returned.
Match All
Show Source
{
"description":"<p>Running job details for the site. If there is a job running for the site the details will be returned.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
}
Nested Schema : lastModifiedBy
User, client application or service that last modified this site.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User, client application or service that last modified this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : members
Type: object
Users and groups the site has been shared with.
Introduced in release 19.4.3.
Show Source
{
"description":"<p>Users and groups the site has been shared with.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Match All
Show Source
-
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.
{
"description":"<p>Users and groups the site has been shared with.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Nested Schema : ownedBy
User or client application that owns this site.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application that owns this site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : permissions
Type: object
User permissions for the site.
Introduced in release 22.7.2.
Show Source
-
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
Introduced in release 22.7.2.
-
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
Introduced in release 22.7.2.
-
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
Introduced in release 22.7.2.
-
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
Introduced in release 22.7.2.
-
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
Introduced in release 22.7.2.
-
shareLink(optional):
array shareLink
Set of share link permissions the user has.
Valid values are:
-
read
- Read and list shared links -
create
- Create a share link -
update
- Update a share link -
delete
- Delete a share link
Introduced in release 22.7.2.
{
"description":"<p>User permissions for the site.</p><small>Introduced in release 22.7.2.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"self":{
"description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"file":{
"description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"members":{
"description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"shareLink":{
"description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"annotation":{
"description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"conversation":{
"description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
Nested Schema : repository
The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.
Introduced in release 19.2.3.
Match All
Show Source
-
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.
{
"description":"<p>The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
}
Nested Schema : request
Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.
Match All
Show Source
-
allOf
Request
Discriminator: requestType
A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.
{
"description":"<p>Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Request"
}
]
}
Nested Schema : security
Match All
Show Source
-
object
SiteSecurity
Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only site administrators can change the security policy of a site.
{
"description":"<p>Site security settings.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteSecurity"
}
]
}
Nested Schema : siteCategory
Private site category generated for SST sites.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
Match All
Show Source
-
allOf
TaxonomyCategory
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
{
"description":"<p>Private site category generated for SST sites.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/TaxonomyCategory"
}
]
}
Nested Schema : sitePageOptions
Site page options.
Introduced in release 23.2.1.
Match All
Show Source
-
object
SitePageOptions
Site page options.
For page specific options such as disable url validation check or enable server side rendering.
Introduced in release 23.2.1.
{
"description":"<p>Site page options.</p><small>Introduced in release 23.2.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SitePageOptions"
}
]
}
Nested Schema : staticSiteDeliveryOptions
Static site options.
Introduced in release 20.3.3.
Match All
Show Source
-
object
StaticSiteDeliveryOptions
Static site delivery options.
For static sites i.e. compiled sites how long these sites are cached and what mobile user-agents call for adaptive mobile layouts supported by site compilation.
Introduced in release 20.3.3.
{
"description":"<p>Static site options.</p><small>Introduced in release 20.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/StaticSiteDeliveryOptions"
}
]
}
Nested Schema : theme
Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.
Introduced in release 19.4.1.
Match All
Show Source
-
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.
{
"description":"<p>Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Theme"
}
]
}
Nested Schema : thumbnail
Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.
Match All
Show Source
-
allOf
Image
Site and site template thumbnail or preview image details.
{
"description":"<p>Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/Image"
}
]
}
Nested Schema : updates
Type: object
Updates for the site.
Introduced in release 21.9.1.
Show Source
{
"description":"<p>Updates for the site.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/SiteUpdate"
}
]
}
}
},
"required":[
"items"
]
}
Match All
Show Source
-
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.
{
"description":"<p>Updates for the site.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/SiteUpdate"
}
]
}
}
},
"required":[
"items"
]
}
Nested Schema : userSecurity
Site security settings relating to OCE user types.
Introduced in release 21.10.2.
Match All
Show Source
-
object
SiteUserSecurity
Defines security settings relating to OCE user types, for instance whether the site should allow external users to be granted certain permissions
Introduced in release 21.10.2.
{
"description":"<p>Site security settings relating to OCE user types.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SiteUserSecurity"
}
]
}
Nested Schema : vanityDomain
Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.
Introduced in release 21.5.1.
Match All
Show Source
-
allOf
VanityDomain
Defines a vanity domain for a site. Once configured, a vanity domain may be used in place of the site domain to access the site.
Introduced in release 21.5.1.
{
"description":"<p>Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.</p><small>Introduced in release 21.5.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/VanityDomain"
}
]
}
Nested Schema : items
Type: array
Collection of Site Access Member elements.
Introduced in release 19.4.3.
Show Source
{
"description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
Nested Schema : 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.
Match All
Show Source
-
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]
{
"description":"<p>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.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"totalResults":{
"description":"<p>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 <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
},
"limit":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"count":{
"description":"<p>Total number of resources in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"hasMore":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"boolean"
},
"offset":{
"description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
}
}
}
]
}
Nested Schema : CollectionResource-allOf[1]
Type: object
Show Source
-
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 to true
by the client.
{
"properties":{
"totalResults":{
"description":"<p>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 <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
},
"limit":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"count":{
"description":"<p>Total number of resources in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"hasMore":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"boolean"
},
"offset":{
"description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
}
}
}
Nested Schema : items
Type: object
Show Source
-
displayName(optional):
string
Display name for the user, client application or group.
Introduced in release 19.4.3.
-
group(optional):
group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.3.
-
groupType(optional):
string
If the member is a group, then the type of group is specified. If the member is a user this field is not present.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
Introduced in release 20.1.1.
-
id:
string
Identifier for the user, client application or group member.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.3.
-
isExternalUser(optional):
boolean
Will be set to true if the associated user or client application has only the external user role.
Introduced in release 21.10.2.
-
name:
string
Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.
Introduced in release 19.4.3.
-
type:
string
Indicates the member is a user, client application or group.
Valid values are:
-
user
- Member is a user or a client application. No distinction is made between a member that is a user or a
member that is a client application.
-
group
- Member is a group
Introduced in release 19.4.3.
-
user(optional):
user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.3.
{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
Nested Schema : group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.3.
Match All
Show Source
-
allOf
Group
A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.
{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
Nested Schema : user
User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.
Introduced in release 19.4.3.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : Group
A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.
Match All
Show Source
-
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]
{
"description":"<p>A group is a collection of users and groups. A group has a human readable group name.</p><small>Introduced in release 19.3.1.</small>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupName":{
"description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"roles":{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
]
}
Nested Schema : Group-allOf[1]
Type: object
Show Source
-
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
Reserved for future use.
-
CECIntegrationUser
- Integration User
Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
-
CECSitesVisitor
- Sites Visitor
Access sites restricted to visitors.
Introduced in release 21.10.2.
-
type(optional):
string
Type of the group.
Valid values are:
-
oce
- Content management group -
idp
- identity provider group
Introduced in release 19.3.1.
{
"properties":{
"id":{
"description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupName":{
"description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"roles":{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
Nested Schema : roles
Type: 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
Reserved for future use.
-
CECIntegrationUser
- Integration User
Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
-
CECSitesVisitor
- Sites Visitor
Access sites restricted to visitors.
Introduced in release 21.10.2.
Show Source
{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : Identity
Discriminator: 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.
Match All
Show Source
-
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]
{
"description":"<p>Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.</p><small>Introduced in release 20.3.1.</small>",
"discriminator":"type",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"type":{
"description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"id":{
"description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"roles":{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
]
}
Nested Schema : Identity-allOf[1]
Type: object
Show Source
-
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
Reserved for future use.
-
CECIntegrationUser
- Integration User
Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
-
CECSitesVisitor
- Sites Visitor
Access sites restricted to visitors.
Introduced in release 21.10.2.
-
type(optional):
string
Type of Identity. Valid values are: user
, service
, application
, unknown
.
Introduced in release 20.3.1.
{
"properties":{
"type":{
"description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"id":{
"description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"roles":{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
Nested Schema : roles
Type: 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
Reserved for future use.
-
CECIntegrationUser
- Integration User
Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
-
CECSitesVisitor
- Sites Visitor
Access sites restricted to visitors.
Introduced in release 21.10.2.
Show Source
{
"description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : Channel
A publishing channel determines the release rules that are applied to an item in a repository. A channel can be public and available to everyone, or secure and limited. A repository can use multiple channels. You can select specific channels to use with specific assets in the repository, letting you decide the policies to be applied in individual cases.
Match All
Show Source
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Channel-allOf[1]
{
"description":"<p>A publishing channel determines the release rules that are applied to an item in a repository. A channel can be public and available to everyone, or secure and limited. A repository can use multiple channels. You can select specific channels to use with specific assets in the repository, letting you decide the policies to be applied in individual cases.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Unique identifier for the channel.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the channel to give consumers an idea of what content this channel contains.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"createdBy":{
"description":"<p>User that created the channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"createdDate":{
"description":"<p>Date and time the channel was created.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"updatedBy":{
"description":"<p>User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"updatedDate":{
"description":"<p>Date and time the channel was last updated.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"channelType":{
"description":"<p>User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.</p><p>Valid values are:\n<ul><li> <code>public</code> - Public channel</li><li> <code>secure</code> - Secure channel</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isSiteChannel":{
"description":"<p>Flag to indicate whether the channel is site channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"publishPolicy":{
"description":"<p>Publish policy of the channel.</p><p>Valid values are:\n<ul><li> <code>anythingPublished</code> - Any asset can be published</li><li> <code>onlyApproved</code> - Only approved assets can be published</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"localizationPolicy":{
"description":"<p>Localization policy of the channel.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"channelTokens":{
"description":"<p>Tokens associated with this channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelToken"
}
]
}
}
}
}
]
}
Nested Schema : Channel-allOf[1]
Type: object
Show Source
{
"properties":{
"id":{
"description":"<p>Unique identifier for the channel.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the channel to give consumers an idea of what content this channel contains.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"createdBy":{
"description":"<p>User that created the channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"createdDate":{
"description":"<p>Date and time the channel was created.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"updatedBy":{
"description":"<p>User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"updatedDate":{
"description":"<p>Date and time the channel was last updated.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"channelType":{
"description":"<p>User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.</p><p>Valid values are:\n<ul><li> <code>public</code> - Public channel</li><li> <code>secure</code> - Secure channel</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isSiteChannel":{
"description":"<p>Flag to indicate whether the channel is site channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"publishPolicy":{
"description":"<p>Publish policy of the channel.</p><p>Valid values are:\n<ul><li> <code>anythingPublished</code> - Any asset can be published</li><li> <code>onlyApproved</code> - Only approved assets can be published</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"localizationPolicy":{
"description":"<p>Localization policy of the channel.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"channelTokens":{
"description":"<p>Tokens associated with this channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelToken"
}
]
}
}
}
}
Nested Schema : channelTokens
Type: array
Tokens associated with this channel.
Show Source
{
"description":"<p>Tokens associated with this channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelToken"
}
]
}
}
Nested Schema : createdDate
Date and time the channel was created.
Match All
Show Source
{
"description":"<p>Date and time the channel was created.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
Nested Schema : updatedDate
Date and time the channel was last updated.
Match All
Show Source
{
"description":"<p>Date and time the channel was last updated.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
Nested Schema : items
Match All
Show Source
-
object
ChannelToken
Authorization token that allows public access to a channel without authentication.
{
"allOf":[
{
"$ref":"#/definitions/ChannelToken"
}
]
}
Nested Schema : ChannelToken
Type: object
Authorization token that allows public access to a channel without authentication.
Show Source
{
"description":"<p>Authorization token that allows public access to a channel without authentication.</p>",
"properties":{
"name":{
"description":"<p>Name of the token.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"token":{
"description":"<p>Token value.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"expirationDate":{
"description":"<p>Date the token expires.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
}
}
Nested Schema : expirationDate
Match All
Show Source
{
"description":"<p>Date the token expires.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
Nested Schema : DateTimeZone
Type: object
Date, time and time zone.
Show Source
{
"description":"<p>Date, time and time zone.</p>",
"properties":{
"value":{
"description":"<p>Date in ISO 8601 format. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"timezone":{
"description":"<p>Timezone in Olson database format.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"description":{
"description":"<p>Description of the date, time and time zone information.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
Nested Schema : TaxonomyCategory
Category of a Taxonomy.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
Match All
Show Source
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
TaxonomyCategory-allOf[1]
{
"description":"<p>Category of a Taxonomy.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Unique identifier for the Taxonomy Category.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"status":{
"description":"<p>Taxonomy Category status.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"parentId":{
"description":"<p>Parent id of the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"apiName":{
"description":"<p>Uniquely identifies a Taxonomy Category across Taxonomies.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"position":{
"description":"<p>The position of the Taxonomy Category among its siblings.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"namePath":{
"description":"<p>Full name path from the root category to this category separated by '/'.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
]
}
Nested Schema : TaxonomyCategory-allOf[1]
Type: object
Show Source
-
apiName(optional):
string
Uniquely identifies a Taxonomy Category across Taxonomies.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
description(optional):
string
Human-readable description of the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
id(optional):
string
Unique identifier for the Taxonomy Category.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
name(optional):
string
Short human-readable name to identify the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
namePath(optional):
string
Full name path from the root category to this category separated by '/'.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
parentId(optional):
string
Parent id of the Taxonomy Category.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
position(optional):
integer(int32)
The position of the Taxonomy Category among its siblings.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
status(optional):
string
Taxonomy Category status.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
{
"properties":{
"id":{
"description":"<p>Unique identifier for the Taxonomy Category.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"status":{
"description":"<p>Taxonomy Category status.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"parentId":{
"description":"<p>Parent id of the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"apiName":{
"description":"<p>Uniquely identifies a Taxonomy Category across Taxonomies.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"position":{
"description":"<p>The position of the Taxonomy Category among its siblings.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"namePath":{
"description":"<p>Full name path from the root category to this category separated by '/'.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
Nested Schema : RepositoryCollection
Collections are a way to group content items, digital assets, and documents for use on a website, external application or for marketing campaigns. Collections are specific to individual repositories and can be used to manage a subset of items in a repository. All the items in the collection will adhere to the publishing channel that is assigned to the collection.
Match All
Show Source
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
RepositoryCollection-allOf[1]
{
"description":"<p>Collections are a way to group content items, digital assets, and documents for use on a website, external application or for marketing campaigns. Collections are specific to individual repositories and can be used to manage a subset of items in a repository. All the items in the collection will adhere to the publishing channel that is assigned to the collection.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Unique identifier for the collection.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the collection to give consumers an idea of what content this collection is for.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"createdBy":{
"description":"<p>User that created the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"createdDate":{
"description":"<p>Date and time the collection was created.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"updatedBy":{
"description":"<p>User that last updated the collection. If the collection has not been updated the updated by will be the user that created the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"updatedDate":{
"description":"<p>Date and time the collection was last updated.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"channels":{
"description":"<p>Channels associated with the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
}
}
}
]
}
Nested Schema : RepositoryCollection-allOf[1]
Type: object
Show Source
{
"properties":{
"id":{
"description":"<p>Unique identifier for the collection.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the collection to give consumers an idea of what content this collection is for.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"createdBy":{
"description":"<p>User that created the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"createdDate":{
"description":"<p>Date and time the collection was created.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"updatedBy":{
"description":"<p>User that last updated the collection. If the collection has not been updated the updated by will be the user that created the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"updatedDate":{
"description":"<p>Date and time the collection was last updated.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"channels":{
"description":"<p>Channels associated with the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
}
}
}
Nested Schema : channels
Type: array
Channels associated with the collection.
Show Source
{
"description":"<p>Channels associated with the collection.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
}
Nested Schema : createdDate
Date and time the collection was created.
Match All
Show Source
{
"description":"<p>Date and time the collection was created.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
Nested Schema : updatedDate
Date and time the collection was last updated.
Match All
Show Source
{
"description":"<p>Date and time the collection was last updated.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
Nested Schema : items
Match All
Show Source
{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
Nested Schema : ChannelId
Type: object
Show Source
-
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.
{
"description":"<p>Channel identifier.</p>",
"properties":{
"id":{
"description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>Short unique human-readable name to identify the channel.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
Nested Schema : SiteJobStatus
Discriminator: action
Background job details for site jobs.
Match All
Show Source
-
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]
{
"description":"<p>Background job details for site jobs.</p>",
"discriminator":"action",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"action":{
"description":"<p>Type of <em>Site Job Status</em>. Valid values are: <code></code>, <code>translate</code>, <code>copy</code>, <code>publish</code>, <code>importTranslations</code>, <code>hardDelete</code>, <code>copyTheme</code>, <code>copyComponent</code>, <code>refresh</code>, <code>publishTheme</code>.</p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"context":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"startTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"endTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"progress":{
"description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> 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: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completed":{
"description":"<p>Whether the asynchronous job is completed or not.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"requestStatus":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"message":{
"description":"<p>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.</p>",
"x-multiLingual":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completedPercentage":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"intervalToPoll":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"error":{
"description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object"
},
"result":{
"description":"<p>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 <code>requestStatus</code> 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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/HttpResponse"
}
]
}
}
}
]
}
Nested Schema : SiteJobStatus-allOf[1]
Type: object
Show Source
-
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 value blocked
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
A processing request failed before it was completed.
-
aborted
- Request was aborted
A processing request was aborted before it was completed.
-
paused
- Request was running, but is now paused -
blocked
- Request is blocked
Request requires action, such as waiting for a human to approve something.
-
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.
{
"properties":{
"action":{
"description":"<p>Type of <em>Site Job Status</em>. Valid values are: <code></code>, <code>translate</code>, <code>copy</code>, <code>publish</code>, <code>importTranslations</code>, <code>hardDelete</code>, <code>copyTheme</code>, <code>copyComponent</code>, <code>refresh</code>, <code>publishTheme</code>.</p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"context":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"startTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"endTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"progress":{
"description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> 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: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completed":{
"description":"<p>Whether the asynchronous job is completed or not.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"requestStatus":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"message":{
"description":"<p>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.</p>",
"x-multiLingual":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completedPercentage":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"intervalToPoll":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"error":{
"description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object"
},
"result":{
"description":"<p>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 <code>requestStatus</code> 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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/HttpResponse"
}
]
}
}
}
Nested Schema : error
Type: object
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
Nested Schema : 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.
Match All
Show Source
-
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.
{
"description":"<p>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 <code>requestStatus</code> 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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/HttpResponse"
}
]
}
Nested Schema : HttpResponse
Type: object
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
Show Source
{
"description":"<p>Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.</p>",
"properties":{
"status":{
"description":"<p>HTTP status code response value and reason.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object",
"properties":{
"code":{
"description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"reason":{
"description":"<p>Short, human-readable summary of the status code.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
},
"required":[
"code",
"reason"
]
},
"headers":{
"description":"<p>HTTP response headers.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"<p>Header name.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"value":{
"description":"<p>Header value.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
},
"required":[
"name"
]
}
}
}
}
Nested Schema : status
Type: object
HTTP status code response value and reason.
Show Source
-
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.
{
"description":"<p>HTTP status code response value and reason.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object",
"properties":{
"code":{
"description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"reason":{
"description":"<p>Short, human-readable summary of the status code.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
},
"required":[
"code",
"reason"
]
}
Nested Schema : items
Type: array
Collection of Site Member elements.
Introduced in release 19.4.1.
Show Source
{
"description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
Nested Schema : items
Type: object
Show Source
-
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
Introduced in release 20.1.1.
-
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
Introduced in release 19.4.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
member that is a client application.
-
group
- Member is a group
Introduced in release 19.4.1.
-
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.
{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
Nested Schema : group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1.
Match All
Show Source
-
allOf
Group
A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.
{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
Nested Schema : 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.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : annotation
Type: array
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : conversation
Type: 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
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : file
Type: 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
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : links
Type: 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.
Show Source
{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
}
Nested Schema : members
Type: 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
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : self
Type: 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
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : shareLink
Type: array
Set of share link permissions the user has.
Valid values are:
-
read
- Read and list shared links -
create
- Create a share link -
update
- Update a share link -
delete
- Delete a share link
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : items
Match All
Show Source
-
object
Link
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.
{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
Nested Schema : 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.
Match All
Show Source
-
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]
{
"description":"<p>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.</p><p>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.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"minimal",
"basic",
"default"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the repository.</p>",
"x-returnedIn":[
"representation",
"basic",
"default"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"createdBy":{
"description":"<p>User that created the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"createdDate":{
"description":"<p>Date and time the repository was created.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"updatedBy":{
"description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"updatedDate":{
"description":"<p>Date and time the repository was last updated.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"autoTagEnabled":{
"description":"<p>Whether auto tagging is enabled for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"contentTypes":{
"description":"<p>Content types associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ContentTypeId"
}
]
}
},
"channels":{
"description":"<p>Channels associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
},
"defaultLanguage":{
"description":"<p>Default language of the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"languageOptions":{
"description":"<p>Language options for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
},
"roleName":{
"description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
}
}
}
]
}
Nested Schema : Repository-allOf[1]
Type: object
Show Source
{
"properties":{
"id":{
"description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"minimal",
"basic",
"default"
],
"type":"string"
},
"name":{
"description":"<p>Short human-readable name to identify the repository.</p>",
"x-returnedIn":[
"representation",
"basic",
"default"
],
"type":"string"
},
"description":{
"description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"createdBy":{
"description":"<p>User that created the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"createdDate":{
"description":"<p>Date and time the repository was created.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"updatedBy":{
"description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"updatedDate":{
"description":"<p>Date and time the repository was last updated.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
},
"autoTagEnabled":{
"description":"<p>Whether auto tagging is enabled for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"contentTypes":{
"description":"<p>Content types associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ContentTypeId"
}
]
}
},
"channels":{
"description":"<p>Channels associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
},
"defaultLanguage":{
"description":"<p>Default language of the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"languageOptions":{
"description":"<p>Language options for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
},
"roleName":{
"description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
}
}
}
Nested Schema : channels
Type: array
Channels associated with the repository.
Show Source
{
"description":"<p>Channels associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
}
Nested Schema : contentTypes
Type: array
Content types associated with the repository.
Show Source
{
"description":"<p>Content types associated with the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/ContentTypeId"
}
]
}
}
Nested Schema : createdDate
Date and time the repository was created.
Match All
Show Source
{
"description":"<p>Date and time the repository was created.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
Nested Schema : languageOptions
Type: array
Language options for the repository.
Show Source
{
"description":"<p>Language options for the repository.</p>",
"x-returnedIn":[
"representation",
"default"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : updatedDate
Date and time the repository was last updated.
Match All
Show Source
{
"description":"<p>Date and time the repository was last updated.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/DateTimeZone"
}
]
}
Nested Schema : items
Match All
Show Source
{
"allOf":[
{
"$ref":"#/definitions/ChannelId"
}
]
}
Nested Schema : items
Match All
Show Source
{
"allOf":[
{
"$ref":"#/definitions/ContentTypeId"
}
]
}
Nested Schema : ContentTypeId
Type: object
Show Source
{
"description":"<p>Content type identifier.</p>",
"properties":{
"name":{
"description":"<p>Content type name.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
Nested Schema : Request
Discriminator: requestType
A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.
Match All
Show Source
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Request-allOf[1]
{
"description":"<p>A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more <em>reviews</em> to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.</p>",
"discriminator":"requestType",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"requestType":{
"description":"<p>Type of <em>Request</em>. Valid values are: <code>SiteRequest</code>, <code>CopySiteRequest</code>.</p>",
"x-queryable":true,
"x-returnedIn":[
"representation"
],
"type":"string"
},
"id":{
"description":"<p>Globally unique immutable identifier for a request.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"minimal",
"basic",
"default"
],
"type":"string"
},
"isDeleted":{
"description":"<p>Indicates that the request is has been marked as soft deleted.</p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"justification":{
"description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"reviews":{
"description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Review</em> elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Review"
}
]
}
}
},
"required":[
"items"
]
},
"status":{
"description":"<p>Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation"
],
"type":"string"
},
"job":{
"description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"context":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"startTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"endTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"progress":{
"description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> 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: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completed":{
"description":"<p>Whether the asynchronous job is completed or not.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"requestStatus":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"message":{
"description":"<p>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.</p>",
"x-multiLingual":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completedPercentage":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"intervalToPoll":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"error":{
"description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object"
},
"result":{
"description":"<p>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 <code>requestStatus</code> 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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/HttpResponse"
}
]
}
},
"required":[
"progress",
"completed"
]
},
"failure":{
"description":"<p>If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object"
},
"createdBy":{
"description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"createdAt":{
"description":"<p>Date and time the request was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"lastModifiedAt":{
"description":"<p>Date and time the request was last updated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"original":{
"description":"<p>Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This <em>forked</em> request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.</p>",
"x-returnedIn":[
"representation"
],
"type":"string"
},
"revision":{
"description":"<p>Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"policy":{
"description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/Policy"
}
]
},
"approvers":{
"description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
}
}
]
}
Nested Schema : Request-allOf[1]
Type: object
Show Source
-
approvers(optional):
object approvers
List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.
Introduced in release 19.3.3.
-
createdAt(optional):
string(date-time)
Date and time the request was created. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
-
createdBy(optional):
createdBy
Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.
-
failure(optional):
object failure
If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.
-
id(optional):
string
Globally unique immutable identifier for a request.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
isDeleted(optional):
boolean
Indicates that the request is has been marked as soft deleted.
-
job(optional):
object job
When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is blocked
- blocked waiting for approval. A completed request will also have a job status that is completed
.
-
justification(optional):
string
Maximum Length: 1000
The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
-
lastModifiedAt(optional):
string(date-time)
Date and time the request was last updated. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
-
original(optional):
string
Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This forked request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.
-
policy(optional):
policy
Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.
Introduced in release 19.2.1.
-
requestType(optional):
string
Type of Request. Valid values are: SiteRequest
, CopySiteRequest
.
-
reviews(optional):
object reviews
Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.
-
revision(optional):
integer(int64)
Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong ETag
value for this resource.
-
status(optional):
string
Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.
Valid values are:
-
pending
- Request is pending approval -
rejected
- Request has not been approved -
approved
- Request has been approved -
failed
- Request has been approved but failed during the request processing -
complete
- Request has been approved and is now complete
{
"properties":{
"requestType":{
"description":"<p>Type of <em>Request</em>. Valid values are: <code>SiteRequest</code>, <code>CopySiteRequest</code>.</p>",
"x-queryable":true,
"x-returnedIn":[
"representation"
],
"type":"string"
},
"id":{
"description":"<p>Globally unique immutable identifier for a request.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"minimal",
"basic",
"default"
],
"type":"string"
},
"isDeleted":{
"description":"<p>Indicates that the request is has been marked as soft deleted.</p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"justification":{
"description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"reviews":{
"description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Review</em> elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Review"
}
]
}
}
},
"required":[
"items"
]
},
"status":{
"description":"<p>Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation"
],
"type":"string"
},
"job":{
"description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"context":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"startTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"endTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"progress":{
"description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> 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: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completed":{
"description":"<p>Whether the asynchronous job is completed or not.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"requestStatus":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"message":{
"description":"<p>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.</p>",
"x-multiLingual":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completedPercentage":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"intervalToPoll":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"error":{
"description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object"
},
"result":{
"description":"<p>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 <code>requestStatus</code> 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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/HttpResponse"
}
]
}
},
"required":[
"progress",
"completed"
]
},
"failure":{
"description":"<p>If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object"
},
"createdBy":{
"description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"createdAt":{
"description":"<p>Date and time the request was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"lastModifiedAt":{
"description":"<p>Date and time the request was last updated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"original":{
"description":"<p>Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This <em>forked</em> request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.</p>",
"x-returnedIn":[
"representation"
],
"type":"string"
},
"revision":{
"description":"<p>Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"policy":{
"description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/Policy"
}
]
},
"approvers":{
"description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
}
}
Nested Schema : approvers
Type: object
List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.
Introduced in release 19.3.3.
Show Source
-
items:
array items
Collection of Request Approvers Member elements.
Introduced in release 19.3.3.
{
"description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Match All
Show Source
-
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.
{
"description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Nested Schema : createdBy
Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : failure
Type: object
If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.
Nested Schema : job
Type: object
When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is blocked
- blocked waiting for approval. A completed request will also have a job status that is completed
.
Show Source
-
completed:
boolean
Whether the asynchronous job is completed or not.
-
completedPercentage(optional):
integer(int32)
A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.
-
context(optional):
string
Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.
-
endTime(optional):
string(date-time)
Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
-
error(optional):
object error
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
-
intervalToPoll(optional):
integer(int64)
A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
message(optional):
string
Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.
-
progress:
string
The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: succeeded
, failed
, aborted
. The value blocked
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
A processing request failed before it was completed.
-
aborted
- Request was aborted
A processing request was aborted before it was completed.
-
paused
- Request was running, but is now paused -
blocked
- Request is blocked
Request requires action, such as waiting for a human to approve something.
-
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.
{
"description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"context":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"startTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"endTime":{
"description":"<p>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 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"progress":{
"description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> 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: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completed":{
"description":"<p>Whether the asynchronous job is completed or not.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"requestStatus":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"message":{
"description":"<p>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.</p>",
"x-multiLingual":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"completedPercentage":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"intervalToPoll":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"error":{
"description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"object"
},
"result":{
"description":"<p>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 <code>requestStatus</code> 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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/HttpResponse"
}
]
}
},
"required":[
"progress",
"completed"
]
}
Nested Schema : policy
Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.
Introduced in release 19.2.1.
Match All
Show Source
-
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.
{
"description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/Policy"
}
]
}
Nested Schema : reviews
Type: object
Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.
Show Source
{
"description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Review</em> elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Review"
}
]
}
}
},
"required":[
"items"
]
}
Match All
Show Source
-
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.
{
"description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Review</em> elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Review"
}
]
}
}
},
"required":[
"items"
]
}
Nested Schema : items
Type: array
Collection of Request Approvers Member elements.
Introduced in release 19.3.3.
Show Source
{
"description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
Nested Schema : items
Type: object
Show Source
-
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
Introduced in release 20.1.1.
-
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
member that is a client application.
-
group
- Member is a group
Introduced in release 19.3.3.
-
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.
{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
Nested Schema : group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3.
Match All
Show Source
-
allOf
Group
A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.
{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
Nested Schema : 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.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : error
Type: object
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
Nested Schema : links
Type: 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.
Show Source
{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
}
Nested Schema : 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.
Match All
Show Source
-
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.
{
"description":"<p>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 <code>requestStatus</code> 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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/HttpResponse"
}
]
}
Nested Schema : items
Match All
Show Source
-
object
Link
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.
{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
Nested Schema : 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.
Match All
Show Source
-
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]
{
"description":"<p>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.</p><p>A policy is associated with a resource, for example a <em>site creation</em> 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.</p><p>A policy can be marked as <em>inactive</em> which prevents the operation from being performed or requested.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Globally unique identifier for a policy.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"minimal",
"basic"
],
"type":"string"
},
"status":{
"description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"approvalType":{
"description":"<p>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.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"approvers":{
"description":"<p>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 <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"accessType":{
"description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"access":{
"description":"<p>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 <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"security":{
"description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SecurityPolicy"
}
]
},
"repository":{
"description":"<p>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.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
},
"localizationPolicyAllowed":{
"description":"<p>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.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"sitePrefixAllowed":{
"description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, 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.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"expiration":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SiteExpirationPeriod"
}
]
},
"revision":{
"description":"<p>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 <code>ETag</code> value for this resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
}
}
}
]
}
Nested Schema : Policy-allOf[1]
Type: object
Show Source
-
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 accessType
of the policy is set to restricted
.
Introduced in release 19.3.1.
-
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
Introduced in release 19.3.1.
-
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 true
, a request for a new site can include an explicit site prefix. If false
, 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.
Introduced in release 19.2.3.
-
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
{
"properties":{
"id":{
"description":"<p>Globally unique identifier for a policy.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"minimal",
"basic"
],
"type":"string"
},
"status":{
"description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"approvalType":{
"description":"<p>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.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"approvers":{
"description":"<p>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 <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"accessType":{
"description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default"
],
"type":"string"
},
"access":{
"description":"<p>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 <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"security":{
"description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SecurityPolicy"
}
]
},
"repository":{
"description":"<p>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.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
},
"localizationPolicyAllowed":{
"description":"<p>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.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"sitePrefixAllowed":{
"description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, 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.</p><small>Introduced in release 19.2.3.</small>",
"x-returnedIn":[
"representation",
"default"
],
"type":"boolean"
},
"expiration":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SiteExpirationPeriod"
}
]
},
"revision":{
"description":"<p>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 <code>ETag</code> value for this resource.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
}
}
}
Nested Schema : access
Type: 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
.
Introduced in release 19.3.1.
Show Source
-
items:
array items
Collection of Policy Access Member elements.
Introduced in release 19.3.1.
{
"description":"<p>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 <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Match All
Show Source
-
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.
{
"description":"<p>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 <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Nested Schema : approvers
Type: 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.
Show Source
-
items:
array items
Collection of Policy Approvers Member elements.
Introduced in release 19.3.3.
{
"description":"<p>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 <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Match All
Show Source
-
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.
{
"description":"<p>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 <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Nested Schema : 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.
Match All
Show Source
-
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.
{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SiteExpirationPeriod"
}
]
}
Nested Schema : 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.
Match All
Show Source
-
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.
{
"description":"<p>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.</p><small>Introduced in release 19.2.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Repository"
}
]
}
Nested Schema : security
Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.
Match All
Show Source
-
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.
{
"description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
"x-returnedIn":[
"representation",
"default"
],
"allOf":[
{
"$ref":"#/definitions/SecurityPolicy"
}
]
}
Nested Schema : items
Type: array
Collection of Policy Access Member elements.
Introduced in release 19.3.1.
Show Source
{
"description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
Nested Schema : items
Type: object
Show Source
-
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
Introduced in release 20.1.1.
-
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
member that is a client application.
-
group
- Member is a group
Introduced in release 19.3.1.
-
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.
{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
Nested Schema : group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.1.
Match All
Show Source
-
allOf
Group
A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.
{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
Nested Schema : 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.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : items
Type: array
Collection of Policy Approvers Member elements.
Introduced in release 19.3.3.
Show Source
{
"description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
}
Nested Schema : items
Type: object
Show Source
-
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
Introduced in release 20.1.1.
-
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
member that is a client application.
-
group
- Member is a group
Introduced in release 19.3.3.
-
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.
{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.3.3.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"type",
"name"
]
}
Nested Schema : group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.3.3.
Match All
Show Source
-
allOf
Group
A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.
{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
Nested Schema : 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.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : SiteExpirationPeriod
Type: 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.
Show Source
-
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
Introduced in release 19.4.1.
{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"properties":{
"amount":{
"description":"<p>Amount of time used to measure site expiration.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int32"
},
"unit":{
"description":"<p>Unit of time used to measure site expiration.</p><p>Valid values are:\n<ul><li> <code>months</code> - Expiration expressed in the number of months</li><li> <code>years</code> - Expiration expressed in the number of years</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
Nested Schema : SecurityPolicy
Type: 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.
Show Source
-
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
{
"description":"<p>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.</p>",
"properties":{
"level":{
"description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"appliesTo":{
"description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
Nested Schema : items
Type: array
Collection of Review elements.
Show Source
{
"description":"<p>Collection of <em>Review</em> elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Review"
}
]
}
}
Nested Schema : items
Match All
Show Source
-
allOf
Review
A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.
{
"allOf":[
{
"$ref":"#/definitions/Review"
}
]
}
Nested Schema : Review
A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.
Match All
Show Source
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
Review-allOf[1]
{
"description":"<p>A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, <em>auto approved</em> requests do not need a review. An <em>administrator approval</em> requires one administrator to review the request.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"decision":{
"description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"comment":{
"description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"createdAt":{
"description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"reviewedBy":{
"description":"<p>Get the details of the user or client application that created the review.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
}
}
]
}
Nested Schema : Review-allOf[1]
Type: object
Show Source
-
comment(optional):
string
-
createdAt(optional):
string(date-time)
Date and time that the review was created. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
-
decision(optional):
string
Outcome of this review, either approve or reject the request.
Valid values are:
-
approved
- Associated request is approved -
rejected
- Associated request is rejected
-
id(optional):
integer(int32)
Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
reviewedBy(optional):
reviewedBy
Get the details of the user or client application that created the review.
{
"properties":{
"id":{
"description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"decision":{
"description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"comment":{
"description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"createdAt":{
"description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"reviewedBy":{
"description":"<p>Get the details of the user or client application that created the review.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
}
}
Nested Schema : reviewedBy
Get the details of the user or client application that created the review.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>Get the details of the user or client application that created the review.</p>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : SiteSecurity
Type: object
Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only site administrators can change the security policy of a site.
Show Source
-
access(optional):
array access
The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.
Valid values are:
-
named
- Selected named users -
service
- All service users -
visitors
- All service visitors -
cloud
- All cloud users who sign in to your domain -
everyone
- Anyone without signing in
-
policy(optional):
policy
The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.
{
"description":"<p>Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only <strong>site administrators</strong> can change the security policy of a site.</p>",
"properties":{
"policy":{
"description":"<p>The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SecurityPolicy"
}
]
},
"access":{
"description":"<p>The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.</p><p>Valid values are:\n<ul><li> <code>named</code> - Selected named users</li><li> <code>service</code> - All service users</li><li> <code>visitors</code> - All service visitors</li><li> <code>cloud</code> - All cloud users who sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
Nested Schema : access
Type: array
The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.
Valid values are:
-
named
- Selected named users -
service
- All service users -
visitors
- All service visitors -
cloud
- All cloud users who sign in to your domain -
everyone
- Anyone without signing in
Show Source
{
"description":"<p>The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.</p><p>Valid values are:\n<ul><li> <code>named</code> - Selected named users</li><li> <code>service</code> - All service users</li><li> <code>visitors</code> - All service visitors</li><li> <code>cloud</code> - All cloud users who sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : policy
The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.
Match All
Show Source
-
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.
{
"description":"<p>The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"allOf":[
{
"$ref":"#/definitions/SecurityPolicy"
}
]
}
Nested Schema : SitePageOptions
Type: object
Site page options.
For page specific options such as disable url validation check or enable server side rendering.
Introduced in release 23.2.1.
Show Source
{
"description":"<p>Site page options.</p><p>For page specific options such as disable url validation check or enable server side rendering.</p><small>Introduced in release 23.2.1.</small>",
"properties":{
"urlValidationDisabled":{
"description":"<p>Disable the page url validation check that occurs when delivering a site page.</p><small>Introduced in release 23.2.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"ssrEnabled":{
"description":"<p>Enable server side rendering (SSR) when delivering a site page.</p><small><span style=\"color: red;\">* </span>New in release 23.12.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"ssrReady":{
"description":"<p>Whether it is ready to enable server side rendering (SSR) for delivering a site page.</p><small><span style=\"color: red;\">* </span>New in release 23.12.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
}
}
}
Nested Schema : StaticSiteDeliveryOptions
Type: object
Static site delivery options.
For static sites i.e. compiled sites how long these sites are cached and what mobile user-agents call for adaptive mobile layouts supported by site compilation.
Introduced in release 20.3.3.
Show Source
-
cachingResponseHeaders(optional):
string
-
compileSite(optional):
boolean
Compile Site. Should the site be compiled for static site delivery.
Introduced in release 20.3.3.
-
mobileUserAgents(optional):
string
Maximum Length: 2000
Mobile user agents. Comma separated list of user-agent substrings to specify the user agents to generate mobile pages for. When compiling a site, mobile pages can be created to support adaptive layouts. If any part of the substring matches the browser's user-agent string, then the mobile pages are served.
Introduced in release 20.3.3.
{
"description":"<p>Static site delivery options.</p><p>For static sites i.e. compiled sites how long these sites are cached and what mobile user-agents call for adaptive mobile layouts supported by site compilation.</p><small>Introduced in release 20.3.3.</small>",
"properties":{
"compileSite":{
"description":"<p>Compile Site. Should the site be compiled for static site delivery.</p><small>Introduced in release 20.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"cachingResponseHeaders":{
"description":"<p>Caching response headers. Additional headers which are added to a site's page to override the default caching headers. By default compiled sites are cached on a user's browser for 300 seconds (5 minutes). This can be overriden by entering a valid <code>Cache-control</code> header. If Akamai is used an <code>Edge-Control</code> header can be used to override the Akamai caching configuration. </p><small>Introduced in release 20.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":2000
},
"mobileUserAgents":{
"description":"<p>Mobile user agents. Comma separated list of user-agent substrings to specify the user agents to generate mobile pages for. When compiling a site, mobile pages can be created to support adaptive layouts. If any part of the substring matches the browser's user-agent string, then the mobile pages are served. </p><small>Introduced in release 20.3.3.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":2000
}
}
}
Nested Schema : 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.
Match All
Show Source
-
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]
{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Immutable identifier for the theme.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Human readable name for the theme. </p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":255
},
"ownedBy":{
"description":"<p>User or client application that owns this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"createdBy":{
"description":"<p>User or client application that created this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"lastModifiedBy":{
"description":"<p>User, client application or service that last modified this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"members":{
"description":"<p>Users and groups the theme has been shared with.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"permissions":{
"description":"<p>User permissions for the theme.</p><small>Introduced in release 22.7.2.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"self":{
"description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"file":{
"description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"members":{
"description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"shareLink":{
"description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"annotation":{
"description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"conversation":{
"description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
},
"isDeleted":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"description":{
"description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"createdAt":{
"description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"lastModifiedAt":{
"description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"publishStatus":{
"description":"<p>Indicates whether the theme is published or not.</p><p>Valid values are:\n<ul><li> <code>unpublished</code> - Theme is unpublished</li><li> <code>published</code> - Theme is published</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"job":{
"description":"<p>Status for current job assigned to the theme.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
},
"isStarter":{
"description":"<p>Indicates that the theme is a starter theme. Starter themes are copies of existing themes for the purpose of experimentation when developing new sites.</p><small>Introduced in release 22.8.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
}
}
}
]
}
Nested Schema : Theme-allOf[1]
Type: object
Show Source
-
createdAt(optional):
string(date-time)
Date and time of creation. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Introduced in release 19.4.1.
-
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 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
Introduced in release 19.4.1.
-
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
Introduced in release 19.4.1.
{
"properties":{
"id":{
"description":"<p>Immutable identifier for the theme.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Human readable name for the theme. </p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":255
},
"ownedBy":{
"description":"<p>User or client application that owns this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"createdBy":{
"description":"<p>User or client application that created this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"lastModifiedBy":{
"description":"<p>User, client application or service that last modified this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"members":{
"description":"<p>Users and groups the theme has been shared with.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
},
"required":[
"items"
]
},
"permissions":{
"description":"<p>User permissions for the theme.</p><small>Introduced in release 22.7.2.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"self":{
"description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"file":{
"description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"members":{
"description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"shareLink":{
"description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"annotation":{
"description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"conversation":{
"description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
},
"isDeleted":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"description":{
"description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"createdAt":{
"description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"lastModifiedAt":{
"description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"publishStatus":{
"description":"<p>Indicates whether the theme is published or not.</p><p>Valid values are:\n<ul><li> <code>unpublished</code> - Theme is unpublished</li><li> <code>published</code> - Theme is published</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"job":{
"description":"<p>Status for current job assigned to the theme.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
},
"isStarter":{
"description":"<p>Indicates that the theme is a starter theme. Starter themes are copies of existing themes for the purpose of experimentation when developing new sites.</p><small>Introduced in release 22.8.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
}
}
}
Nested Schema : createdBy
User or client application that created this theme.
Introduced in release 19.4.1.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application that created this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : job
Status for current job assigned to the theme.
Introduced in release 21.9.1.
Match All
Show Source
{
"description":"<p>Status for current job assigned to the theme.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
}
Nested Schema : lastModifiedBy
User, client application or service that last modified this theme.
Introduced in release 19.4.1.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User, client application or service that last modified this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : members
Type: object
Users and groups the theme has been shared with.
Introduced in release 19.4.3.
Show Source
{
"description":"<p>Users and groups the theme has been shared with.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Match All
Show Source
-
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.
{
"description":"<p>Users and groups the theme has been shared with.</p><small>Introduced in release 19.4.3.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
},
"required":[
"items"
]
}
Nested Schema : ownedBy
User or client application that owns this theme.
Introduced in release 19.4.1.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application that owns this theme.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : permissions
Type: object
User permissions for the theme.
Introduced in release 22.7.2.
Show Source
-
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
Introduced in release 22.7.2.
-
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
Introduced in release 22.7.2.
-
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
Introduced in release 22.7.2.
-
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
Introduced in release 22.7.2.
-
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
Introduced in release 22.7.2.
-
shareLink(optional):
array shareLink
Set of share link permissions the user has.
Valid values are:
-
read
- Read and list shared links -
create
- Create a share link -
update
- Update a share link -
delete
- Delete a share link
Introduced in release 22.7.2.
{
"description":"<p>User permissions for the theme.</p><small>Introduced in release 22.7.2.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"type":"object",
"properties":{
"links":{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
},
"self":{
"description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"file":{
"description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"members":{
"description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"shareLink":{
"description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"annotation":{
"description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
},
"conversation":{
"description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
}
}
Nested Schema : items
Type: array
Collection of Theme Member elements.
Introduced in release 19.4.1.
Show Source
{
"description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
}
Nested Schema : items
Type: object
Show Source
-
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
Introduced in release 20.1.1.
-
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
Introduced in release 19.4.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
member that is a client application.
-
group
- Member is a group
Introduced in release 19.4.1.
-
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.
{
"type":"object",
"properties":{
"id":{
"description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"role":{
"description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"type":{
"description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"groupType":{
"description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"name":{
"description":"<p>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.</p><small>Introduced in release 19.4.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"displayName":{
"description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"isExternalUser":{
"description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
},
"user":{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"group":{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
},
"required":[
"id",
"role",
"type",
"name"
]
}
Nested Schema : group
Group details of the member. Only available if the member has a type of group.
Introduced in release 19.4.1.
Match All
Show Source
-
allOf
Group
A group is a collection of users and groups. A group has a human readable group name.
Introduced in release 19.3.1.
{
"description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Group"
}
]
}
Nested Schema : 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.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : annotation
Type: array
Set of annotation permissions the user has.
Valid values are:
-
read
- Read annotation -
write
- Write an annotation -
update
- Update annotation -
delete
- Delete annotation
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : conversation
Type: 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
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : file
Type: 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
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : links
Type: 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.
Show Source
{
"description":"<p>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.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
}
Nested Schema : members
Type: 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
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : self
Type: 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
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : shareLink
Type: array
Set of share link permissions the user has.
Valid values are:
-
read
- Read and list shared links -
create
- Create a share link -
update
- Update a share link -
delete
- Delete a share link
Introduced in release 22.7.2.
Show Source
{
"description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : items
Match All
Show Source
-
object
Link
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.
{
"allOf":[
{
"$ref":"#/definitions/Link"
}
]
}
Nested Schema : Image
Site and site template thumbnail or preview image details.
Match All
Show Source
-
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]
{
"description":"<p>Site and site template thumbnail or preview image details.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"url":{
"description":"<p>URL of this image.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"uri"
},
"imageType":{
"description":"<p>Image type.</p><p>Valid values are:\n<ul><li> <code>thumbnail</code> - Thumbnail representation of a site or template</li><li> <code>preview</code> - Preview image of what the site or template looks like</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
]
}
Nested Schema : Image-allOf[1]
Type: object
Show Source
{
"properties":{
"url":{
"description":"<p>URL of this image.</p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"uri"
},
"imageType":{
"description":"<p>Image type.</p><p>Valid values are:\n<ul><li> <code>thumbnail</code> - Thumbnail representation of a site or template</li><li> <code>preview</code> - Preview image of what the site or template looks like</li></p>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
Nested Schema : items
Type: array
Collection of Site Update elements.
Introduced in release 21.9.1.
Show Source
{
"description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/SiteUpdate"
}
]
}
}
Nested Schema : items
Match All
Show Source
-
allOf
SiteUpdate
An update is a named collection of changes to the current base site. The changes remain in the update until you commit them and permanently update the base site.
Introduced in release 21.9.1.
{
"allOf":[
{
"$ref":"#/definitions/SiteUpdate"
}
]
}
Nested Schema : SiteUpdate
An update is a named collection of changes to the current base site. The changes remain in the update until you commit them and permanently update the base site.
Introduced in release 21.9.1.
Match All
Show Source
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
SiteUpdate-allOf[1]
{
"description":"<p>An update is a named collection of changes to the current base site. The changes remain in the update until you commit them and permanently update the base site.</p><small>Introduced in release 21.9.1.</small>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"id":{
"description":"<p>Immutable identifier.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 21.9.1.</small>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Human readable name for the site update. </p><small>Introduced in release 21.9.1.</small>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":255
},
"description":{
"description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 21.9.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"ownedBy":{
"description":"<p>User or client application that owns this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"createdAt":{
"description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 21.9.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"createdBy":{
"description":"<p>User or client application that created this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"lastModifiedAt":{
"description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 21.9.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"lastModifiedBy":{
"description":"<p>User or client application that last modified this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"allowedActions":{
"description":"<p>Allowed user actions on the folder.</p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"isDeleted":{
"description":"<p>Indicates that the item has been soft deleted.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
}
}
}
]
}
Nested Schema : SiteUpdate-allOf[1]
Type: object
Show Source
{
"properties":{
"id":{
"description":"<p>Immutable identifier.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 21.9.1.</small>",
"x-queryable":true,
"x-opaque":true,
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"string"
},
"name":{
"description":"<p>Human readable name for the site update. </p><small>Introduced in release 21.9.1.</small>",
"x-queryable":true,
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":255
},
"description":{
"description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 21.9.1.</small>",
"x-queryable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"maxLength":1000
},
"ownedBy":{
"description":"<p>User or client application that owns this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"createdAt":{
"description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 21.9.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"createdBy":{
"description":"<p>User or client application that created this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"lastModifiedAt":{
"description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 21.9.1.</small>",
"x-sortable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string",
"format":"date-time"
},
"lastModifiedBy":{
"description":"<p>User or client application that last modified this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
},
"allowedActions":{
"description":"<p>Allowed user actions on the folder.</p><small>Introduced in release 22.7.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"integer",
"format":"int64"
},
"isDeleted":{
"description":"<p>Indicates that the item has been soft deleted.</p><small>Introduced in release 19.4.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
}
}
}
Nested Schema : createdBy
User or client application that created this resource.
Introduced in release 21.9.1.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application that created this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : lastModifiedBy
User or client application that last modified this resource.
Introduced in release 21.9.1.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application that last modified this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : ownedBy
User or client application that owns this resource.
Introduced in release 21.9.1.
Match All
Show Source
-
allOf
Identity
Discriminator: 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.
{
"description":"<p>User or client application that owns this resource.</p><small>Introduced in release 21.9.1.</small>",
"x-expandable":true,
"x-returnedIn":[
"representation",
"default",
"basic"
],
"x-expandedIn":[
"representation"
],
"allOf":[
{
"$ref":"#/definitions/Identity"
}
]
}
Nested Schema : SiteUserSecurity
Type: object
Defines security settings relating to OCE user types, for instance whether the site should allow external users to be granted certain permissions
Introduced in release 21.10.2.
Show Source
-
externalUserEnabled(optional):
boolean
Indicates whether a site should allow external users. If true, the site will allow some (limited) privileges for external users, including (non-managing) member roles to be given to the such users.
Introduced in release 21.10.2.
{
"description":"<p>Defines security settings relating to OCE user types, for instance whether the site should allow external users to be granted certain permissions</p><small>Introduced in release 21.10.2.</small>",
"properties":{
"externalUserEnabled":{
"description":"<p>Indicates whether a site should allow external users. If true, the site will allow some (limited) privileges for external users, including (non-managing) member roles to be given to the such users.</p><small>Introduced in release 21.10.2.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"boolean"
}
}
}
Nested Schema : VanityDomain
Defines a vanity domain for a site. Once configured, a vanity domain may be used in place of the site domain to access the site.
Introduced in release 21.5.1.
Match All
Show Source
-
object
SingularResource
All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.
-
object
VanityDomain-allOf[1]
{
"description":"<p>Defines a vanity domain for a site. Once configured, a vanity domain may be used in place of the site domain to access the site.</p><small>Introduced in release 21.5.1.</small>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"name":{
"description":"<p>The vanity domain for this site.</p><small>Introduced in release 21.5.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"configurationStatus":{
"description":"<p>The configuration status of this vanity domain. The domain is not immediately available to users once set, configuration to make it available may take up to 60 mins to complete.</p><p>Valid values are:\n<ul><li> <code>processing</code> - Vanity domain configuration is in process</li><li> <code>completed</code> - Vanity domain configuration has completed</li><li> <code>failed</code> - Vanity domain configuration has failed</li></p><small>Introduced in release 21.5.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}
]
}
Nested Schema : VanityDomain-allOf[1]
Type: object
Show Source
-
configurationStatus(optional):
string
The configuration status of this vanity domain. The domain is not immediately available to users once set, configuration to make it available may take up to 60 mins to complete.
Valid values are:
-
processing
- Vanity domain configuration is in process -
completed
- Vanity domain configuration has completed -
failed
- Vanity domain configuration has failed
Introduced in release 21.5.1.
-
name(optional):
string
The vanity domain for this site.
Introduced in release 21.5.1.
{
"properties":{
"name":{
"description":"<p>The vanity domain for this site.</p><small>Introduced in release 21.5.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
},
"configurationStatus":{
"description":"<p>The configuration status of this vanity domain. The domain is not immediately available to users once set, configuration to make it available may take up to 60 mins to complete.</p><p>Valid values are:\n<ul><li> <code>processing</code> - Vanity domain configuration is in process</li><li> <code>completed</code> - Vanity domain configuration has completed</li><li> <code>failed</code> - Vanity domain configuration has failed</li></p><small>Introduced in release 21.5.1.</small>",
"x-returnedIn":[
"representation",
"default",
"basic"
],
"type":"string"
}
}
}