1. REST API for Sites Management
  2. Tasks
  3. Sites

Get the Repository Associated with the Site

get

/sites/management/api/v1/sites/{id}/repository

RELATION

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.

Authorization

To invoke this operation, the authenticated user or client application must have been shared with the resource and have one of the following sharing roles:

  • Owner
  • Manager
  • Contributor
  • Downloader
  • Viewer

Path Alternative Identifiers

The default identifier for a Site resource is the Site Identifier. The Site resource supports alternative identifiers.

nameSite Name

Instead of the site identifier, the site name can be used to uniquely identify a site in the resource path. The default resource path parameter for a site is the site identifier, but when working with sites the human-readable site name is sometimes easier.

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/repository

Introduced in release 19.4.1.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK

Request

GET https://api.example.com/sites/management/api/v1/sites/{id}/repository

Response Body

{
  "id": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "name": "Company Assets",
  "description": "A repository that should be used for an internal company images and documentation.",
  "createdBy": "jsmith",
  "createdDate": {
    "value": "2019-06-01T06:44:17.000Z",
    "timezone": "GMT"
  },
  "updatedBy": "jsmith",
  "updatedDate": {
    "value": "2019-06-01T06:44:17.000Z",
    "timezone": "GMT"
  },
  "autoTagEnabled": false,
  "contentTypes": [
      {
        "name": "MyType"
      }
  ],
  "channels": [
      {
        "id": "CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC",
        "name": "AcmeProductLaunch"
      }
  ],
  "defaultLanguage": "en-US",
  "languageOptions": [
      "en-US"
  ],
  "roleName": "owner"
}

Client Error Response Examples

This operation responds with following client error (4xx) responses with exception details in the response body. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

404Not Found - Site Name Ambiguous

The name provided does not uniquely identify a site. If a deleted site is referenced by name and there are multiple deleted sites with the same name this error will occur. This error provides details of the deleted sites with the same name.

Error Code

OCE-SITEMGMT-009090

Resolution - Use the Site Identifier

Use the unique site identifier instead of the name to identify the site.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
siteSite that does not exist or is not visible to the authenticated user.
sitesSites that match on name.

For detailed information about this exception detail type, consult the SiteNameAmbiguousExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Name Ambiguous",
  "status": "404",
  "detail": "Multiple sites exist with an identifier of '{site.id}'.",
  "o:errorCode": "OCE-SITEMGMT-009090",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "sites": [
      {
        "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0",
        "name": "MyNewProduct",
        "isExpired": false,
        "isDeleted": false,
        "description": "A folder for my assets.",
        "createdAt": "2019-06-01T06:44:17.000Z",
        "lastModifiedAt": "2019-06-01T06:44:17.000Z",
        "thumbnail": {
          "url": "http://cloud.example.com/images/site.png",
          "imageType": "thumbnail"
        },
        "isEnterprise": false,
        "themeName": "value",
        "defaultLanguage": "en-US",
        "runtimeStatus": "offline",
        "offlineAt": "2019-06-01T06:44:17.000Z",
        "onlineAt": "2019-06-01T06:44:17.000Z",
        "publishStatus": "unpublished",
        "publishedAt": "2019-06-01T06:44:17.000Z",
        "unpublishedAt": "2019-06-01T06:44:17.000Z",
        "expiresAt": "2019-06-01T06:44:17.000Z",
        "security": {
          "policy": {
            "level": "service",
            "appliesTo": "named"
          },
          "access": [
              "named"
          ]
        },
        "userSecurity": {
          "externalUserEnabled": false
        },
        "sitePrefix": "News",
        "templateName": "value",
        "isIframeEmbeddingAllowed": false,
        "numberOfUpdates": 1234,
        "job": {
          "action": "copy",
          "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423",
          "startTime": "2018-05-21T12:01:15.123Z",
          "endTime": "2018-05-21T12:01:15.123Z",
          "progress": "pending",
          "completed": false,
          "requestStatus": 200,
          "message": "Running",
          "completedPercentage": "50",
          "intervalToPoll": "2000",
          "error": {
            "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
            "title": "Internal Error",
            "status": "500",
            "detail": "An internal error occurred.",
            "o:errorCode": "ORA-999999"
          },
          "result": {
            "status": {
              "code": "200",
              "reason": "OK"
            },
            "headers": [
                {
                  "name": "Content-Type",
                  "value": "application/json"
                }
            ]
          }
        },
        "staticSiteDeliveryOptions": {
          "compileSite": false,
          "cachingResponseHeaders": "Cache-control: max-age=600",
          "mobileUserAgents": "Mobile"
        },
        "compilationStatus": "value",
        "sitePageOptions": {
          "urlValidationDisabled": false,
          "ssrEnabled": false,
          "ssrReady": false
        }
      }
  ]
}

Introduced in release 20.1.1.

404Not Found - Site Not Found

The site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.

Error Code

OCE-SITEMGMT-009003

Resolution - Check Identifier

Check that the site identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the site or a site administrator.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
siteSite that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the SiteNotFoundExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Not Found",
  "status": "404",
  "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
  "o:errorCode": "OCE-SITEMGMT-009003",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

404Not Found - Relationship Not Found

An attempt to read a relationship has failed because the relationship does not exist. Reading a relationship can fail if the relationship no longer exists or the authenticated identity is not authorized to read the relationship details.

Error Code

PAAS-005027

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Relationship Not Found",
  "status": "404",
  "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
  "o:errorCode": "PAAS-005027"
}

This resource represents the relationship between a Site and Repository resource. If there is no Repository associated with the Site then the response status code will be 204 No Content. If the Repository has been deleted or the authenticated user is not authorized to read the resource then the response status code will be 404 Not Found and a Relationship Not Found error will be returned in the response body.

Request

Path Parameters
Query Parameters

  • Comma-delimited string of field names that should not be included in the response.

  • Comma-separated list of link relation names to exclude from the response.

  • Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.

  • Resources that have been marked for deletion can be read, modified, and support extended operations as long this query parameter is set to true. When the includeDeleted query parameter is not sent then the response to read, modification, and extended operations will be identical to that which would be returned if the resource was permanently deleted.

  • Comma-separated list of link relation names to include in the response. By default, all links are returned.

    The following links are provided by this resource:

    Link RelationshipDescription
    parentDescribes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
    selfDescribes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
    canonicalDescribes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
    describedByDescribes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.

  • Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the fields, excludeFields, links, excludeLinks and expand query parameters.

    The following representations are supported with the return query parameter:

    RepresentationDescription
    representationFull resource representation includes all properties and links and expands most relationships.
    defaultDefault resource representation includes most properties and links.
    basicBasic resource representation includes some properties and some links.
    minimalMinimal resource representation, includes essential properties and no links.
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Match All
Show Source
  • 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.

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
  • 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.

  • Repository-allOf[1]
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
Nested Schema : Repository-allOf[1]
Type: object
Show Source
Nested Schema : channels
Type: array

Channels associated with the repository.

Show Source
Nested Schema : contentTypes
Type: array

Content types associated with the repository.

Show Source
Nested Schema : createdDate

Date and time the repository was created.

Match All
Show Source
Nested Schema : languageOptions
Type: array

Language options for the repository.

Show Source
Nested Schema : updatedDate

Date and time the repository was last updated.

Match All
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : ChannelId
Type: object

Channel identifier.

Show Source

  • 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.

  • Short unique human-readable name to identify the channel.

Nested Schema : items
Match All
Show Source
Nested Schema : ContentTypeId
Type: object

Content type identifier.

Show Source
Nested Schema : DateTimeZone
Type: object

Date, time and time zone.

Show Source
Example Response ()
{
    "id":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
    "name":"Company Assets",
    "description":"A repository that should be used for an internal company images and documentation.",
    "createdBy":"jsmith",
    "createdDate":{
        "value":"2019-06-01T06:44:17.000Z",
        "timezone":"GMT"
    },
    "updatedBy":"jsmith",
    "updatedDate":{
        "value":"2019-06-01T06:44:17.000Z",
        "timezone":"GMT"
    },
    "autoTagEnabled":false,
    "contentTypes":[
        {
            "name":"MyType"
        }
    ],
    "channels":[
        {
            "id":"CHANNELF4643F274ED1B242A10CBC1D5A81D8159BCD6382C8CC",
            "name":"AcmeProductLaunch"
        }
    ],
    "defaultLanguage":"en-US",
    "languageOptions":[
        "en-US"
    ],
    "roleName":"owner"
}

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteNameAmbiguousExceptionDetail
Introduced in release 20.1.1.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : SiteNameAmbiguousExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Nested Schema : sites
Type: array

Sites that match on name.

Introduced in release 20.1.1.
Show Source
Nested Schema : items
Match All
Show Source
  • 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.

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
  • 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.

  • Site-allOf[1]
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
Nested Schema : Site-allOf[1]
Type: object
Show Source
  • access

    Users and groups that can access the site.

    Introduced in release 19.4.3.
  • 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.

  • 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

    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.

  • 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

    User or client application that created this site.

  • 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.

  • Default language for translation.

  • 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.

  • 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.

  • 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.

  • 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.

  • Is this an Enterprise site.

  • 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.

  • Whether this site can be embedded in an iFrame.

  • job

    Running job details for the site. If there is a job running for the site the details will be returned.

  • 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

    User, client application or service that last modified this site.

  • members

    Users and groups the site has been shared with.

    Introduced in release 19.4.3.
  • Maximum Length: 242

    Human readable name for the site.

  • Number of updates made on this site.

  • 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.

  • 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

    User or client application that owns this site.

  • permissions

    User permissions for the site.

    Introduced in release 22.7.2.

  • 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.

  • 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

    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

    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.

  • 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

    Site security settings.

  • 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

    Site page options.

    Introduced in release 23.2.1.
  • 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

    Static site options.

    Introduced in release 20.3.3.

  • Name of the template that was used to create this site.

  • 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.

  • Name of the theme used by this template.

  • thumbnail

    Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.

  • 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

    Updates for the site.

    Introduced in release 21.9.1.
  • userSecurity

    Site security settings relating to OCE user types.

    Introduced in release 21.10.2.
  • 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.
Nested Schema : access
Type: object

Users and groups that can access the site.

Introduced in release 19.4.3.
Show Source
Match All
Show Source
  • 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.

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
  • 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.

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
  • 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.

Nested Schema : createdBy

User or client application that created this site.

Match All
Show Source
  • 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.
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
  • 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.

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
Nested Schema : lastModifiedBy

User, client application or service that last modified this site.

Match All
Show Source
  • 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.
Nested Schema : members
Type: object

Users and groups the site has been shared with.

Introduced in release 19.4.3.
Show Source
Match All
Show Source
  • 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.

Nested Schema : ownedBy

User or client application that owns this site.

Match All
Show Source
  • 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.
Nested Schema : permissions
Type: object

User permissions for the site.

Introduced in release 22.7.2.
Show Source
  • 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

    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

    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
  • 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

    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
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
  • 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.

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
  • 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.

Nested Schema : security

Site security settings.

Match All
Show Source
  • 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.

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
  • 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.

Nested Schema : sitePageOptions

Site page options.

Introduced in release 23.2.1.
Match All
Show Source
  • 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.
Nested Schema : staticSiteDeliveryOptions

Static site options.

Introduced in release 20.3.3.
Match All
Show Source
  • 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.
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
  • 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.
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
  • Image

    Site and site template thumbnail or preview image details.

Nested Schema : updates
Type: object

Updates for the site.

Introduced in release 21.9.1.
Show Source
Match All
Show Source
  • 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.

Nested Schema : userSecurity

Site security settings relating to OCE user types.

Introduced in release 21.10.2.
Match All
Show Source
  • 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.
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
  • 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.
Nested Schema : items
Type: array

Collection of Site Access Member elements.

Introduced in release 19.4.3.
Show Source
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
Nested Schema : CollectionResource-allOf[1]
Type: object
Show Source

  • Total number of resources in the response.

  • 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.

  • 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.

  • Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.

  • 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.

Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.4.3.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.4.3.

  • 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.

  • 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.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • 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.

  • 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

    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.
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
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
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
  • 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.
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
  • 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.

  • Group-allOf[1]
Nested Schema : Group-allOf[1]
Type: object
Show Source

  • Human-readable name for the group.

    Introduced in release 19.3.1.

  • Group name that is unique within the service instance.

    Introduced in release 19.3.1.

  • 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

    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 of the group.

    Valid values are:

    • oce - Content management group
    • idp - identity provider group

    Introduced in release 19.3.1.
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
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
  • 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.

  • Identity-allOf[1]
Nested Schema : Identity-allOf[1]
Type: object
Show Source

  • Human-readable display name.

    Introduced in release 20.3.1.

  • 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.

  • Unique name, such as the user name or client application name.

    Introduced in release 20.3.1.
  • 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 of Identity. Valid values are: user, service, application, unknown.

    Introduced in release 20.3.1.
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
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
  • 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.

  • Channel-allOf[1]
Nested Schema : Channel-allOf[1]
Type: object
Show Source
Nested Schema : channelTokens
Type: array

Tokens associated with this channel.

Show Source
Nested Schema : createdDate

Date and time the channel was created.

Match All
Show Source
Nested Schema : updatedDate

Date and time the channel was last updated.

Match All
Show Source
Nested Schema : items
Match All
Show Source
  • ChannelToken

    Authorization token that allows public access to a channel without authentication.

Nested Schema : ChannelToken
Type: object

Authorization token that allows public access to a channel without authentication.

Show Source
Nested Schema : expirationDate

Date the token expires.

Match All
Show Source
Nested Schema : DateTimeZone
Type: object

Date, time and time zone.

Show Source
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
  • 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.

  • TaxonomyCategory-allOf[1]
Nested Schema : TaxonomyCategory-allOf[1]
Type: object
Show Source

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • Taxonomy Category status.

    Targeted for a Future Release

    This operation is targeted for an undecided future release. This operation may be subject to change.

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
Nested Schema : RepositoryCollection-allOf[1]
Type: object
Show Source
Nested Schema : channels
Type: array

Channels associated with the collection.

Show Source
Nested Schema : createdDate

Date and time the collection was created.

Match All
Show Source
Nested Schema : updatedDate

Date and time the collection was last updated.

Match All
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : ChannelId
Type: object

Channel identifier.

Show Source

  • 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.

  • Short unique human-readable name to identify the channel.

Nested Schema : SiteJobStatus
Discriminator: action

Background job details for site jobs.

Match All
Show Source
  • 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.

  • SiteJobStatus-allOf[1]
Nested Schema : SiteJobStatus-allOf[1]
Type: object
Show Source

  • Type of Site Job Status. Valid values are: , translate, copy, publish, importTranslations, hardDelete, copyTheme, copyComponent, refresh, publishTheme.

  • Whether the asynchronous job is completed or not.

  • 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.

  • 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.

  • 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

    Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.

  • 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.

  • 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.

  • 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.

  • 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

    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.

  • 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.

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
  • HttpResponse

    Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.

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
Nested Schema : headers
Type: array

HTTP response headers.

Show Source
Nested Schema : status
Type: object

HTTP status code response value and reason.

Show Source

  • The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of 404.

  • Short, human-readable summary of the status code.

Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array

Collection of Site Member elements.

Introduced in release 19.4.1.
Show Source
Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.4.1.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.4.1.

  • 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.

  • 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.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • 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.

  • 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.

  • 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

    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.
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
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
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
  • 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.
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
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
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
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
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
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
  • 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.

  • Repository-allOf[1]
Nested Schema : Repository-allOf[1]
Type: object
Show Source
Nested Schema : channels
Type: array

Channels associated with the repository.

Show Source
Nested Schema : contentTypes
Type: array

Content types associated with the repository.

Show Source
Nested Schema : createdDate

Date and time the repository was created.

Match All
Show Source
Nested Schema : languageOptions
Type: array

Language options for the repository.

Show Source
Nested Schema : updatedDate

Date and time the repository was last updated.

Match All
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : ContentTypeId
Type: object

Content type identifier.

Show Source
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
  • 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.

  • Request-allOf[1]
Nested Schema : Request-allOf[1]
Type: object
Show Source
  • 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.

  • 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

    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

    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.

  • 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.

  • Indicates that the request is has been marked as soft deleted.

  • 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.

  • 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.

  • 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 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

    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.

  • Type of Request. Valid values are: SiteRequest, CopySiteRequest.

  • 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.

  • 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.

  • 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

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

    Collection of Request Approvers Member elements.

    Introduced in release 19.3.3.
Match All
Show Source
  • 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.

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
  • 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.
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

  • Whether the asynchronous job is completed or not.

  • 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.

  • 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.

  • 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

    Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.

  • 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

  • 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.

  • 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.

  • 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

    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.

  • 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.

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
  • 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.

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
Match All
Show Source
  • 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.

Nested Schema : items
Type: array

Collection of Request Approvers Member elements.

Introduced in release 19.3.3.
Show Source
Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.3.3.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.3.3.

  • 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.

  • 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.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • 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.

  • 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

    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.
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
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
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
  • 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.
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
  • HttpResponse

    Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.

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
  • 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.

  • Policy-allOf[1]
Nested Schema : Policy-allOf[1]
Type: object
Show Source
  • 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.

  • 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.

  • 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

    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

    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.

  • 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.

  • 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

    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.

  • 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

    Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.

  • 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.

  • 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

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
Match All
Show Source
  • 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.

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

    Collection of Policy Approvers Member elements.

    Introduced in release 19.3.3.
Match All
Show Source
  • 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.

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
  • 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.
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
  • 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.

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
  • 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.

Nested Schema : items
Type: array

Collection of Policy Access Member elements.

Introduced in release 19.3.1.
Show Source
Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.3.1.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.3.1.

  • 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.

  • 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.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • 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.

  • 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

    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.
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
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
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
  • 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.
Nested Schema : items
Type: array

Collection of Policy Approvers Member elements.

Introduced in release 19.3.3.
Show Source
Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.3.3.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.3.3.

  • 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.

  • 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.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • 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.

  • 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

    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.
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
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
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
  • 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.
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 of time used to measure site expiration.

    Introduced in release 19.4.1.

  • 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.
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

  • 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

  • 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

Nested Schema : items
Type: array

Collection of Review elements.

Show Source
Nested Schema : items
Match All
Show Source
  • 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.

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
  • 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.

  • Review-allOf[1]
Nested Schema : Review-allOf[1]
Type: object
Show Source
  • Maximum Length: 1000

    A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.

  • 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.

  • Outcome of this review, either approve or reject the request.

    Valid values are:

    • approved - Associated request is approved
    • rejected - Associated request is rejected

  • 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

    Get the details of the user or client application that created the review.

Nested Schema : reviewedBy

Get the details of the user or client application that created the review.

Match All
Show Source
  • 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.
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

    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

    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.

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
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
  • 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.

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
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
  • Maximum Length: 2000

    Caching response headers. Additional headers which are added to a site's page to override the default caching headers. By default compiled sites are cached on a user's browser for 300 seconds (5 minutes). This can be overriden by entering a valid Cache-control header. If Akamai is used an Edge-Control header can be used to override the Akamai caching configuration.

    Introduced in release 20.3.3.

  • Compile Site. Should the site be compiled for static site delivery.

    Introduced in release 20.3.3.
  • 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.
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
  • 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.

  • Theme-allOf[1]
Nested Schema : Theme-allOf[1]
Type: object
Show Source
Nested Schema : createdBy

User or client application that created this theme.

Introduced in release 19.4.1.
Match All
Show Source
  • 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.
Nested Schema : job

Status for current job assigned to the theme.

Introduced in release 21.9.1.
Match All
Show Source
Nested Schema : lastModifiedBy

User, client application or service that last modified this theme.

Introduced in release 19.4.1.
Match All
Show Source
  • 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.
Nested Schema : members
Type: object

Users and groups the theme has been shared with.

Introduced in release 19.4.3.
Show Source
Match All
Show Source
  • 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.

Nested Schema : ownedBy

User or client application that owns this theme.

Introduced in release 19.4.1.
Match All
Show Source
  • 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.
Nested Schema : permissions
Type: object

User permissions for the theme.

Introduced in release 22.7.2.
Show Source
  • 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

    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

    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
  • 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

    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
Nested Schema : items
Type: array

Collection of Theme Member elements.

Introduced in release 19.4.1.
Show Source
Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.4.1.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.4.1.

  • 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.

  • 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.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • 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.

  • 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.

  • 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

    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.
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
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
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
  • 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.
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
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
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
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
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
Nested Schema : Image

Site and site template thumbnail or preview image details.

Match All
Show Source
  • 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.

  • Image-allOf[1]
Nested Schema : Image-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array

Collection of Site Update elements.

Introduced in release 21.9.1.
Show Source
Nested Schema : items
Match All
Show Source
  • 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.
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
  • 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.

  • SiteUpdate-allOf[1]
Nested Schema : SiteUpdate-allOf[1]
Type: object
Show Source
Nested Schema : createdBy

User or client application that created this resource.

Introduced in release 21.9.1.
Match All
Show Source
  • 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.
Nested Schema : lastModifiedBy

User or client application that last modified this resource.

Introduced in release 21.9.1.
Match All
Show Source
  • 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.
Nested Schema : ownedBy

User or client application that owns this resource.

Introduced in release 21.9.1.
Match All
Show Source
  • 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.
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

  • 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.
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
  • 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.

  • VanityDomain-allOf[1]
Nested Schema : VanityDomain-allOf[1]
Type: object
Show Source

  • 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.

  • The vanity domain for this site.

    Introduced in release 21.5.1.
Example Response (Site Name Ambiguous)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Name Ambiguous",
    "status":"404",
    "detail":"Multiple sites exist with an identifier of '{site.id}'.",
    "o:errorCode":"OCE-SITEMGMT-009090",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "sites":[
        {
            "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0",
            "name":"MyNewProduct",
            "isExpired":false,
            "isDeleted":false,
            "description":"A folder for my assets.",
            "createdAt":"2019-06-01T06:44:17.000Z",
            "lastModifiedAt":"2019-06-01T06:44:17.000Z",
            "thumbnail":{
                "url":"http://cloud.example.com/images/site.png",
                "imageType":"thumbnail"
            },
            "isEnterprise":false,
            "themeName":"value",
            "defaultLanguage":"en-US",
            "runtimeStatus":"offline",
            "offlineAt":"2019-06-01T06:44:17.000Z",
            "onlineAt":"2019-06-01T06:44:17.000Z",
            "publishStatus":"unpublished",
            "publishedAt":"2019-06-01T06:44:17.000Z",
            "unpublishedAt":"2019-06-01T06:44:17.000Z",
            "expiresAt":"2019-06-01T06:44:17.000Z",
            "security":{
                "policy":{
                    "level":"service",
                    "appliesTo":"named"
                },
                "access":[
                    "named"
                ]
            },
            "userSecurity":{
                "externalUserEnabled":false
            },
            "sitePrefix":"News",
            "templateName":"value",
            "isIframeEmbeddingAllowed":false,
            "numberOfUpdates":1234,
            "job":{
                "action":"copy",
                "context":"37D1070720325969AC6C47ACE8B9BFF91533560416423",
                "startTime":"2018-05-21T12:01:15.123Z",
                "endTime":"2018-05-21T12:01:15.123Z",
                "progress":"pending",
                "completed":false,
                "requestStatus":200,
                "message":"Running",
                "completedPercentage":"50",
                "intervalToPoll":"2000",
                "error":{
                    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
                    "title":"Internal Error",
                    "status":"500",
                    "detail":"An internal error occurred.",
                    "o:errorCode":"ORA-999999"
                },
                "result":{
                    "status":{
                        "code":"200",
                        "reason":"OK"
                    },
                    "headers":[
                        {
                            "name":"Content-Type",
                            "value":"application/json"
                        }
                    ]
                }
            },
            "staticSiteDeliveryOptions":{
                "compileSite":false,
                "cachingResponseHeaders":"Cache-control: max-age=600",
                "mobileUserAgents":"Mobile"
            },
            "compilationStatus":"value",
            "sitePageOptions":{
                "urlValidationDisabled":false,
                "ssrEnabled":false,
                "ssrReady":false
            }
        }
    ]
}
Example Response (Site Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Not Found",
    "status":"404",
    "detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
    "o:errorCode":"OCE-SITEMGMT-009003",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}
Example Response (Relationship Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Relationship Not Found",
    "status":"404",
    "detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
    "o:errorCode":"PAAS-005027"
}

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top