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

List or Batch Read Components

get

/sites/management/api/v1/components

COLLECTION

List components, returning component details such as component name and description. Because there might be a large number of components, results can be requested in pages.

Introduced in release 19.4.1.

Sharing

Only components that have been shared with the user or the that user owns can be listed or read.

Listing Components in Trash

When a component is soft deleted the component is moved to a trash folder. Components in the trash can be listed. However you cannot list components that are in the trash and not in the trash at the same time. If the contents of the trash need to be listed these semantics have to be expressed in the query parameters. Deleted components are included in the results if the includeDeleted=true query parameter is provided. In addition to this the filter query parameter must be specified as deleted eq "true". This ensures that only deleted components are returned. Combining the include deleted with the filter allows list components in the trash semantics to be expressed.

Listing Components Using a Search Term

The list of components can be filtered by a search term. Any component where the component name or description contains, starts with, ends with or equals the search term will be returned in the response.

Filtering Components By Type

The list of components can be filtered by component type e.g Local. Currently this only supports filtering on a single type or on three well known types - local, sandboxed and template. Types can only be combined via disjunction. Please note that if the type field is used outside of these constraints a bad request status code will be returned.

Limits

If the limit query parameter is not provided this operation uses a default limit of 50 items. The maximum limit that can be specified is 250. If the limit exceeds this maximum then a limit of 250 is used.

Sorting

The default sort order is to sort by lastModifiedAt in descending order.

Batching

This operation supports batching of GET requests. Two or more resource instances up to a maximum of 50 can be returned in a single batch response by specifying a comma-separated list of resource identifiers using the id query parameter. The response will contain details of each GET response, providing the response status code, headers and response body.

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 - List the First Page of Components

Get the first default page of components. Links are not included in the response.

Request

GET https://api.example.com/sites/management/api/v1/components?links=none

Response Body

{
  "totalResults": 2,
  "limit": 50,
  "count": 2,
  "hasMore": false,
  "offset": 0,
  "items": [
      {
        "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588036A",
        "name": "FooterBar",
        "createdAt": "2019-05-12T16:33:28.000Z",
        "lastModifiedAt": "2019-05-19T11:24:45.000Z"
      },
      {
        "id": "FAC37C6C2BD422E8FBA5D0D7A18DA0EC4E552FB7622B",
        "name": "NavMenu",
        "createdAt": "2019-06-03T06:33:08.000Z",
        "lastModifiedAt": "2019-06-03T16:33:08.000Z"
      }
  ]
}

200OK - Batch Read Components

A set of components can be read in one request by specifying the set of component identifiers in a batch read. The response is an array of the responses for each read. Links are not included in the response.

Request

GET https://api.example.com/sites/management/api/v1/components?id=F1E9A5A8892B83A63740A47F160AFA532D71F588036A,FAC37C6C2BD422E8FBA5D0D7A18DA0EC4E552FB7622B&links=none

Response Body

{
  "batch": [
      {
        "status": {
          "code": 200,
          "reason": "OK"
        },
        "headers": [
            {
              "name": "Cache-Control",
              "value": "no-cache, no-store, must-revalidate"
            },
            {
              "name": "Content-Type",
              "value": "application/vnd.oracle.resource+json;type=singular"
            }
        ],
        "body": {
          "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588036A",
          "name": "FooterBar",
          "createdAt": "2019-05-12T16:33:28.000Z",
          "lastModifiedAt": "2019-05-19T11:24:45.000Z"
        }
      },
      {
        "status": {
          "code": 200,
          "reason": "OK"
        },
        "headers": [
            {
              "name": "Cache-Control",
              "value": "no-cache, no-store, must-revalidate"
            },
            {
              "name": "Content-Type",
              "value": "application/vnd.oracle.resource+json;type=singular"
            }
        ],
        "body": {
          "id": "FAC37C6C2BD422E8FBA5D0D7A18DA0EC4E552FB7622B",
          "name": "NavMenu",
          "createdAt": "2019-06-03T06:33:08.000Z",
          "lastModifiedAt": "2019-06-03T16:33:08.000Z"
        }
      }
  ]
}

200OK - List Components in Trash

To list components in the trash, deleted components must be included in the results, specifying a filter that returns just deleted components.

Request

GET https://api.example.com/sites/management/api/v1/components?includeDeleted=true&q=deleted eq "true"
Introduced in release 19.4.3.

200OK - List Components Matching a Search Term

List components where the component name or description contains the value ContentNavMenu.

Request

GET https://api.example.com/sites/management/api/v1/components?q=* x-ocm-match "ContentNavMenu"

Response Body

{
  "totalResults": 1,
  "limit": 50,
  "count": 1,
  "hasMore": false,
  "offset": 0,
  "items": [
      {
        "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588036A",
        "name": "ContentNavMenu",
        "createdAt": "2019-05-12T16:33:28.000Z",
        "lastModifiedAt": "2019-05-19T11:24:45.000Z"
      }
  ]
}
Introduced in release 21.9.1.

200OK - List RSS Template Components

List components where the component type is rssTemplate.

Request

GET https://api.example.com/sites/management/api/v1/components?q=type eq "rssTemplate"

Response Body

{
  "totalResults": 2,
  "limit": 50,
  "count": 2,
  "hasMore": false,
  "offset": 0,
  "items": [
      {
        "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588036A",
        "name": "Content",
        "createdAt": "2019-05-12T16:33:28.000Z",
        "lastModifiedAt": "2019-05-19T11:24:45.000Z",
        "type": "rss"
      },
      {
        "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588041C",
        "name": "FooterBar",
        "createdAt": "2019-05-13T17:33:28.000Z",
        "lastModifiedAt": "2020-05-21T17:24:45.000Z",
        "type": "rss"
      }
  ]
}
Introduced in release 22.8.2.

200OK - List Local, Sandboxed and Template Components Matching A Search Term

List components where the component type is local, sandboxed or template and their name or description contains Content.

Request

GET https://api.example.com/sites/management/api/v1/components?q=(* x-ocm-match "Content") and (type eq "local" or type eq "sandboxed" or type eq "template")

Response Body

{
  "totalResults": 2,
  "limit": 50,
  "count": 2,
  "hasMore": false,
  "offset": 0,
  "items": [
      {
        "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588036A",
        "name": "Content",
        "createdAt": "2019-05-12T16:33:28.000Z",
        "lastModifiedAt": "2019-05-19T11:24:45.000Z",
        "type": "local"
      },
      {
        "id": "F1E9A5A8892B83A63740A47F160AFA532D71F588030R",
        "name": "FooterBar",
        "createdAt": "2019-05-17T16:36:28.000Z",
        "lastModifiedAt": "2020-05-21T11:30:45.000Z",
        "type": "sandboxed"
      }
  ]
}
Introduced in release 22.8.2.

Client Error Response Examples

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

400Bad Request - Deleted Filter Required

When listing resources such as components, themes, sites and templates you can either list resources in the trash or not in the trash; you cannot list resources that are both in and not in the trash. This error indicates that the combination of includeDeleted and the q query parameter are trying to list resources in the trash and not in the trash.

Error Code

OCE-DOCS-001007

Resolution - Listing Resources in Trash

Specify both includeDeleted=true and deleted eq "true" to list resources in the trash.

Resolution - Listing Resources Not in Trash

Do not specify includeDeleted=true or use the expression deleted eq "true" in the filter to list resources not in the trash.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Deleted Filter Required",
  "status": "400",
  "detail": "You cannot list resources in the trash and not in the trash at the same time.",
  "o:errorCode": "OCE-DOCS-001007"
}

Introduced in release 19.4.3.

Request

Query Parameters

  • Comma-delimited string of field names that you do not want 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. To reference the fields of the collection the field name can be prepended with the @ character (for example, @hasMore).

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

  • Comma-delimited string of field names that you want to expand. Use the value all to expand all relationships.

    The following field names can be specified in the expand query parameter:

    Field NameDescription
    ownedByUser or client application that owns this component.
    createdByUser or client application that created this component.
    lastModifiedByUser, client application or service that last modified this component.
    membersUsers and groups the component has been shared with.
    permissionsUser permissions for the component.

  • Specify how errors in expansion are handled. If not specified, then the default is to include error details in the relationship field.

    Valid values are:

    • ignore - Ignore the error and do not expand the relationship. Relationship links are not included in the response
    • include - Include the error details instead of the expanded relationship. Relationship links are returned
    • fail - Fail the request with an expansion failure error response

  • Comma-delimited string of field names that you want in the response. Nested properties 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. To reference the fields of the collection the field name can be prepended with the @ character (for example, @hasMore).

  • List of resource identifiers to use for a batched request. The syntax uses a comma-delimited sequence of resource identifiers.

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

  • Positive integer value that specifies the maximum number of items returned in the response. If not specified the service will choose an appropriate limit.

  • 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.
    childDescribes where a related or child resource can be read. Child links are returned in expandable properties and provide the location where unexpanded relationship details can be read.
    prevDescribes the previous page of results, if a previous page exists. Used with collection resources to provide a previous-page link based on the response to a paged request that specified the offset and limit query parameters.
    nextDescribes the next page of results, if a next page exists. Used with collection resources to provide a next-page link based on the response to a paged request that specified the offset and limit query parameters.
    createDescribes where the resource can be created. Used on collection resources to indicate where a post can be performed to create a new resource in the collection.
    search-formDescribes where the search form can be read that explains the query syntax that can be used. The search form provides details of what search criteria can be used to search a resource.
    create-formDescribes where a template request body for creating a resource can be read. The create form provides details of what properties can be used to create a 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.

  • Non-negative integer value that specifies the index of the first item to be returned. The offset index begins at zero. By default, the offset is zero, which returns items starting from the first item in the collection.

  • Comma-separated string of field names, each optionally followed by :asc or :desc, which specifies the order of items returned in the response.

    The following fields can be used in the orderBy query parameter:

    Field NameDescription
    nameHuman readable name for the component.
    createdAtDate and time of creation.
    lastModifiedAtDate and time of the last modification.

  • Query expression that controls which items are returned in the collection. If a query expression is not provided no filtering is applied to the items.

    The following fields and operators can be used in the q query parameter:

    Field NameSupported Operators
    deletedEquals (eq)
    *Match on Search Term (x-ocm-match)
    typeEquals (eq)

    These operators are described below:

    OperatorDescription
    eq

    Equals operator. The attribute and operator values are identical.

    x-ocm-match

    Operator for matching a field with a search term. The match operator matches the field value if the value starts with, ends with or contains the search term. Typically used with asterisk field name to indicate that any field that supports the match operator is used in the match. For example, when using the asterisk field name with the match operator for sites, themes, templates and components the search matches on name and description.

  • 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
Type: object
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 Component elements.

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

    Components are the individual parts of a web page. When you look at a web page, what do you see? You probably see a few titles, some paragraphs of text, and several links to other pages in the site. You might also see images, buttons, dividers, maps, and galleries. Each of these items is a component.

    Introduced in release 19.4.1.
Nested Schema : Component

Components are the individual parts of a web page. When you look at a web page, what do you see? You probably see a few titles, some paragraphs of text, and several links to other pages in the site. You might also see images, buttons, dividers, maps, and galleries. Each of these items is a component.

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.

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

  • Component category.

    Introduced in release 19.4.1.

  • Date and time of creation. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

    Introduced in release 19.4.1.
  • createdBy

    User or client application that created this component.

    Introduced in release 19.4.1.
  • Maximum Length: 1000

    Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.

    Introduced in release 19.4.1.

  • Immutable identifier for the component.

    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.

  • Indicates that the component has been soft deleted. The corresponding component folder will be in the trash folder of the user that owned the component.

    Introduced in release 19.4.1.

  • Hide the component from the custom palette in the site editor.

    Introduced in release 19.4.1.

  • Date and time of the last modification. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

    Introduced in release 19.4.1.
  • lastModifiedBy

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

    Introduced in release 19.4.1.

  • Name of the image used for the component logo.

    Introduced in release 21.9.1.
  • members

    Users and groups the component has been shared with.

    Introduced in release 19.4.3.
  • Maximum Length: 255

    Human readable name for the component.

    Introduced in release 19.4.1.
  • ownedBy

    User or client application that owns this component.

    Introduced in release 19.4.1.
  • permissions

    User permissions for the component.

    Introduced in release 22.7.2.

  • Indicates whether the component is published or not.

    Valid values are:

    • unpublished - Component is unpublished
    • published - Component is published

    Introduced in release 19.4.1.

  • Component type.

    Valid values are:

    • unknown - Unknown component type
    • componentGroup - Component group
    • contentLayout - Content layout
    • contentForm - Content form
    • fieldEditor - Field editor
    • sectionLayout - Section layout
    • remote - Remote component
    • local - Local component
    • sandboxed - Local component in a sandboxed iFrame
    • visualBuilder - Visual Builder Cloud Service (VBCS) component
    • translationEditor - Translation job editor
    • customFilterPanel - Custom filter panel
    • template - Template component
    • rssTemplate - RSS Template component

    Introduced in release 19.4.1.
Nested Schema : createdBy

User or client application that created this component.

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

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

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

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

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

Collection of Component 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 : 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 : 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
Example Response (List the First Page of Components)
{
    "totalResults":2,
    "limit":50,
    "count":2,
    "hasMore":false,
    "offset":0,
    "items":[
        {
            "id":"F1E9A5A8892B83A63740A47F160AFA532D71F588036A",
            "name":"FooterBar",
            "createdAt":"2019-05-12T16:33:28.000Z",
            "lastModifiedAt":"2019-05-19T11:24:45.000Z"
        },
        {
            "id":"FAC37C6C2BD422E8FBA5D0D7A18DA0EC4E552FB7622B",
            "name":"NavMenu",
            "createdAt":"2019-06-03T06:33:08.000Z",
            "lastModifiedAt":"2019-06-03T16:33:08.000Z"
        }
    ]
}

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : DeletedRequiredExceptionDetail
Introduced in release 19.4.3.
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 : 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 : 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.

Example Response (Deleted Filter Required)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Deleted Filter Required",
    "status":"400",
    "detail":"You cannot list resources in the trash and not in the trash at the same time.",
    "o:errorCode":"OCE-DOCS-001007"
}

401 Response

Unauthorized

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