1. REST API for Sites Management
  2. Tasks
  3. Components
  4. Delete and Restore

Hard Delete a Component

post

/sites/management/api/v1/components/{id}/hardDelete

EXTENDED OPERATION

Permanently deletes a component. Components that are not deleted, or have been soft deleted, may be hard deleted.

Introduced in release 19.4.1.

Authorization

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

  • Owner
  • Manager

Hard Deletes are Permanent

A hard delete cannot be undone. The folder associated with the component is permanently removed.

Asynchronous Processing

This operation supports both asynchronous and synchronous processing. The client can specify a preferred interaction mode by adding a Prefer header with a value of respond-async. The server may change an asynchronous request to synchronous so the client should be prepared to handle both cases. An accepted response will include a Location header, which provides the location of a status resource that can be polled to obtain information about the asynchronous processing.

For more information about reading the status see Get the Progress of a Site Related Job.

Path Alternative Identifiers

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

nameComponent Name

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

http://api.example.com/sites/management/api/v1/components/name:FooterBar/hardDelete

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.

204No Content - Suppress Automatic Soft Delete

Perform a hard delete but only if the component is in the trash (has been soft deleted). If the component is not in the trash the hard delete will fail with a component not deleted error response.

Request

POST https://api.example.com/sites/management/api/v1/components/{id}/hardDelete

Request Headers

X-Soft-Delete-If-Required=false
Introduced in release 20.3.1.

202Accepted - Hard Delete Asynchronously

Perform a hard delete of a component asynchronously.

Request

POST https://api.example.com/sites/management/api/v1/components/{id}/hardDelete

Request Headers

Prefer=respond-async
Introduced in release 21.7.2.

Client Error Response Examples

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

403Forbidden - Component Operation Forbidden

Your sharing role within the component does not allow you to perform the operation.

Error Code

OCE-SITEMGMT-009055

Resolution - Change the Sharing Role

Change the role given to the authenticated user to the required role or higher.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error will not be returned in the asynchronous job status.
Exception Detail Fields

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

Field NameDescription
componentComponent on which the operation is being performed.

For detailed information about this exception detail type, consult the ComponentOperationForbiddenExceptionDetail 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": "Component Operation Forbidden",
  "status": "403",
  "detail": "You do have a sharing role in this component, but your role does not allow you to use this operation.",
  "o:errorCode": "OCE-SITEMGMT-009055",
  "component": {
    "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
  }
}

Introduced in release 19.4.1.

404Not Found - Component Name Ambiguous

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

Error Code

OCE-SITEMGMT-009089

Resolution - Use the Component Identifier

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

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error will not be returned in the asynchronous job status.
Exception Detail Fields

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

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

For detailed information about this exception detail type, consult the ComponentNameAmbiguousExceptionDetail 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": "Component Name Ambiguous",
  "status": "404",
  "detail": "Multiple components exist with an identifier of '{component.id}'.",
  "o:errorCode": "OCE-SITEMGMT-009089",
  "component": {
    "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
  },
  "components": [
      {
        "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
        "name": "ContentNavMenu",
        "isDeleted": false,
        "description": "A folder for my assets.",
        "createdAt": "2019-06-01T06:44:17.000Z",
        "lastModifiedAt": "2019-06-01T06:44:17.000Z",
        "type": "unknown",
        "category": "value",
        "publishStatus": "unpublished",
        "isHidden": false,
        "logo": "value"
      }
  ]
}

Introduced in release 20.1.1.

404Not Found - Component Not Found

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

Error Code

OCE-SITEMGMT-009045

Resolution - Check Identifier

Check that the component identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the component.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error will not be returned in the asynchronous job status.
Exception Detail Fields

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

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

For detailed information about this exception detail type, consult the ComponentNotFoundExceptionDetail 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": "Component Not Found",
  "status": "404",
  "detail": "Component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.",
  "o:errorCode": "OCE-SITEMGMT-009045",
  "component": {
    "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
  }
}

Introduced in release 19.4.1.

409Conflict - Component Not Deleted

The operation cannot be performed as the component has not been soft deleted.

Error Code

OCE-SITEMGMT-009064

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error can be returned in the asynchronous job status.
Exception Detail Fields

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

Field NameDescription
componentComponent that is not soft deleted.

For detailed information about this exception detail type, consult the ComponentNotDeletedExceptionDetail 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": "Component Not Deleted",
  "status": "409",
  "detail": "The operation cannot be performed as the component has not been soft deleted.",
  "o:errorCode": "OCE-SITEMGMT-009064",
  "component": {
    "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
  }
}

Introduced in release 19.4.1.

409Conflict - Component In Use

The component is in use by one or more sites, templates or asset types. and cannot be deleted.

Error Code

OCE-SITEMGMT-009057

Resolution - Hard Delete Site

Hard delete the site that is associated with the component.

Resolution - Hard Delete Template

Hard delete the template that is associated with the component.

Resolution - Remove Component Usage From the Template or Site

Remove the component from the site or template that is using the component.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error can be returned in the asynchronous job status.
Exception Detail Fields

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

Field NameDescription
componentComponent that cannot be deleted because it is in use.
templatesTemplates that use the component.
sitesSites that use the component.
usedBySite resources that are using the component.

For detailed information about this exception detail type, consult the ComponentInUseExceptionDetail 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": "Component In Use",
  "status": "409",
  "detail": "Component cannot be deleted because it is being used by one or more sites, templates or asset types.",
  "o:errorCode": "OCE-SITEMGMT-009057",
  "component": {
    "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
  },
  "templates": [
      {
        "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
      }
  ],
  "sites": [
      {
        "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
      }
  ],
  "usedBy": {
    "sites": [
        {
          "name": "MyNewProduct",
          "site": {
            "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
          }
        }
    ],
    "templates": [
        {
          "name": "CafeSupremo",
          "template": {
            "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
          }
        }
    ],
    "types": [
        {
          "name": "value",
          "type": {
            "name": "Video"
          }
        }
    ],
    "translationConnectors": [
        {
          "name": "value"
        }
    ],
    "sitePlans": [
        {
          "name": "value"
        }
    ]
  }
}

Introduced in release 19.4.1.

Request

Path Parameters
Header Parameters

  • Request asynchronous processing of the request using a respond-async header value.

  • When hard deleting a site, theme, template or component the resource will be automatically soft deleted (moved to trash) if required. To disable this automatic soft delete this header can be used to disable the soft delete step. This can be useful to ensure that a resource has to go through two stages of deletion before it is permanently deleted.

Back to Top

Response

202 Response

Accepted

204 Response

No Content

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : ComponentOperationForbiddenExceptionDetail
Introduced in release 19.4.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 : ComponentOperationForbiddenExceptionDetail-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.

Example Response (Component Operation Forbidden)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Operation Forbidden",
    "status":"403",
    "detail":"You do have a sharing role in this component, but your role does not allow you to use this operation.",
    "o:errorCode":"OCE-SITEMGMT-009055",
    "component":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    }
}

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : ComponentNameAmbiguousExceptionDetail
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 : ComponentNameAmbiguousExceptionDetail-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 : components
Type: array

Components that match on name.

Introduced in release 20.1.1.
Show Source
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 : 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 : 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 : 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.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 (Component Name Ambiguous)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Name Ambiguous",
    "status":"404",
    "detail":"Multiple components exist with an identifier of '{component.id}'.",
    "o:errorCode":"OCE-SITEMGMT-009089",
    "component":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    },
    "components":[
        {
            "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
            "name":"ContentNavMenu",
            "isDeleted":false,
            "description":"A folder for my assets.",
            "createdAt":"2019-06-01T06:44:17.000Z",
            "lastModifiedAt":"2019-06-01T06:44:17.000Z",
            "type":"unknown",
            "category":"value",
            "publishStatus":"unpublished",
            "isHidden":false,
            "logo":"value"
        }
    ]
}
Example Response (Component Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Not Found",
    "status":"404",
    "detail":"Component does not exist or has been deleted, or the authenticated user or client application does not have access to the component.",
    "o:errorCode":"OCE-SITEMGMT-009045",
    "component":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    }
}

409 Response

Conflict
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : ComponentNotDeletedExceptionDetail
Introduced in release 19.4.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 : ComponentNotDeletedExceptionDetail-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.

Example Response (Component Not Deleted)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Not Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the component has not been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009064",
    "component":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    }
}
Example Response (Component In Use)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component In Use",
    "status":"409",
    "detail":"Component cannot be deleted because it is being used by one or more sites, templates or asset types.",
    "o:errorCode":"OCE-SITEMGMT-009057",
    "component":{
        "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8"
    },
    "templates":[
        {
            "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
        }
    ],
    "sites":[
        {
            "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
        }
    ],
    "usedBy":{
        "sites":[
            {
                "name":"MyNewProduct",
                "site":{
                    "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
                }
            }
        ],
        "templates":[
            {
                "name":"CafeSupremo",
                "template":{
                    "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
                }
            }
        ],
        "types":[
            {
                "name":"value",
                "type":{
                    "name":"Video"
                }
            }
        ],
        "translationConnectors":[
            {
                "name":"value"
            }
        ],
        "sitePlans":[
            {
                "name":"value"
            }
        ]
    }
}

413 Response

Payload Too Large

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