Jump to

• Request
• Response

Reject or Approve a Request

post

/sites/management/api/v1/requests/{id}/reviews

COLLECTION

Approve or reject a request. Pending requests can have their status changed to approved or rejected by adding a review. Each review provides the review comments and an approve or reject decision for the request. If the new review approves the the request, the request will be processed automatically; for example, an approved site request would start the create a site process.

Once a review has been created it cannot be deleted or changed as the system may be processing the request. For example, to undo a site request, the site would need to be deleted. Once a request has been approved no further reviews can be created for the request. Only pending, rejected or failed requests can be updated.

Authorization

Users can create reviews if they are allowed to approve or reject the request. This depends on the approval type associated with the request. Administrator approved requests require a site administrator to add a review.

Email Notifications

When a request is approved or rejected an email notification may be sent to the user than created the request informing them that the request has been approved or rejected. The email notification will be sent if the preferences of the user allows the send you email when someone approves or rejects your site creation request notification. No email notifications will ever be sent if notifications are disabled for all users. Email notifications can be suppressed on a per operation basis by providing a suppress notifications request header. Presence of this request header will stop any email notifications being generated regardless of the user preferences.

Monitoring the Progress of an Approved Request

Once a request is approved the request processing will start, for example, a site request will start creating the new site. The progress of the processing can be monitored by polling the request job status.

For more information, see Check the Progress of a Request.

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.

201Created - Approve a Request

Approve a request without a comment. A comment can be provided, this example chooses not to provide a comment.

Request

POST https://api.example.com/sites/management/api/v1/requests/{id}/reviews

Request Body

{
  "decision": "approved"
}

201Created - Reject a Request

Reject a request with a comment explaining why.

Request

POST https://api.example.com/sites/management/api/v1/requests/{id}/reviews

Request Body

{
  "decision": "rejected",
  "comment": "Do not like the site name, can you change it please?"
}

201Created - Approve a Request Suppressing Email Notifications

Approve a request with a comment suppressing any email notifications.

Request

POST https://api.example.com/sites/management/api/v1/requests/{id}/reviews

Request Headers

X-Suppress-Notifications=true

Request Body

{
  "decision": "approved",
  "comment": "Site looks good, approved."
}

Introduced in release 20.1.2.

201Created - Reject a Request Suppressing Email Notifications

Reject a request suppressing any email notifications.

Request

POST https://api.example.com/sites/management/api/v1/requests/{id}/reviews

Request Headers

X-Suppress-Notifications=true

Request Body

{
  "decision": "rejected",
  "comment": "Do not like the site name, can you change it please?"
}

Introduced in release 20.1.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 - Review Rejected

When a review is added to a request the request must not already be rejected or approved. If the request is already approved or rejected no further reviews can be added.

Error Code

OCE-SITEMGMT-009011

Exception Detail Fields

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

Field Name	Description
request	Details of the request for which the review was rejected.

For detailed information about this exception detail type, consult the ReviewRejectedExceptionDetail 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": "Review Rejected",
  "status": "400",
  "detail": "Review has been rejected because the request is already approved, rejected or does not require a review to be approved.",
  "o:errorCode": "OCE-SITEMGMT-009011"
}

403Forbidden - Review Not Allowed

The approval type associated with the policy does not allow the authenticated user to add reviews to the request.

Error Code

OCE-SITEMGMT-009038

Resolution - Check Approvers

Check who can approve the request and ask them to add a review to approve or reject the request.

Exception Detail Fields

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

Field Name	Description
request	Request for which reviews cannot be added for the authenticated user.

For detailed information about this exception detail type, consult the ReviewNotAllowedExceptionDetail 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": "Review Not Allowed",
  "status": "403",
  "detail": "You do not have permissions to add reviews to this request.",
  "o:errorCode": "OCE-SITEMGMT-009038",
  "request": {
    "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7"
  }
}

Introduced in release 19.3.1.

404Not Found - Request Not Found

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

Error Code

OCE-SITEMGMT-009001

Resolution - Check Identifier

Check that the request identifier is valid.

Resolution - Check Authorization

Check that the authenticated user can review the request or that the authenticated user is the user that created the request.

Exception Detail Fields

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

Field Name	Description
request	Request that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the RequestNotFoundExceptionDetail 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": "Request Not Found",
  "status": "404",
  "detail": "Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.",
  "o:errorCode": "OCE-SITEMGMT-009001",
  "request": {
    "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7"
  }
}

409Conflict - Invalid Request Status

The operation cannot be performed due to the current request status. When a request is created, approved, rejected or completed, the request status changes accordingly. Depending on the status of the request, some operations will be prevented. Only a pending or rejected request can be approved. A request that has been approved cannot be edited. Only a failed request can be retried.

Error Code

OCE-SITEMGMT-009009

Exception Detail Fields

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

Field Name	Description
request	Request on which the operation is being performed.
required	Required status of the request for the operation to be valid. 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

For detailed information about this exception detail type, consult the InvalidRequestStatusExceptionDetail 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": "Invalid Request Status",
  "status": "409",
  "detail": "Operation cannot be performed on a request with status '{request.status}'.",
  "o:errorCode": "OCE-SITEMGMT-009009",
  "required": [
      "pending"
  ]
}

Request

Supported Media Types

• application/json

Path Parameters

• id: string

  Globally unique immutable identifier for a request.

Header Parameters

• If-Match(optional): string

  The if match request header is used with a method to make it conditional. A client that has one or more entity tag values previously obtained with the resource can verify that one of those entity tag values is current. If the requested resource does not match any of the provided entity tag values a precondition failed response will be returned without any body.

• If-None-Match(optional): string

  The if none match request header is used with a method to make it conditional. A client that has one or more entity tag values previously obtained with the resource can verify that none of those entity tag values is current.

• X-Suppress-Notifications(optional): boolean

  If a client wants to prevent notifications being sent on a per request basis this header can be set to the value true. Even if the notification would normally be sent, this header will suppress notification delivery for the request.

Body ()

Only properties that are needed to create an instance should be provided. Properties that cannot be set on creation are ignored.

Root Schema : schema

Type: object

Show Source

• comment(optional): string
  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.

• decision: string

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

  Valid values are:

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

• links(optional): array links

  HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

{
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "decision":{
            "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "comment":{
            "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        }
    },
    "required":[
        "decision"
    ],
    "example":{
        "decision":"approved"
    }
}

Example:

{
    "decision":"approved"
}

Nested Schema : links

Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object Link

  REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

Nested Schema : Link

Type: object

REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string

  The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the templated property must be set to true.

• mediaType(optional): string

  Media type, as defined by RFC 2046, describing the link target.

• method(optional): string

  HTTP method for requesting the target of the link.

  Valid values are:

  • OPTIONS - HTTP OPTIONS
  • HEAD - HTTP HEAD
  • GET - HTTP GET
  • POST - HTTP POST
  • PUT - HTTP PUT
  • PATCH - HTTP PATCH
  • DELETE - HTTP DELETE

• profile(optional): string(uri)

  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.

• rel(optional): string

  Name of the link relation that, in addition to the type property, can be used to retrieve link details.

• templated(optional): boolean

  Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the property is not present.

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=singular

201 Response

Created

Headers

• Cache-Control: string

  Directives for caching mechanisms.

• Content-Length: string

  Size of the response body.

• Content-Type: string

  Content type of the response.

• ETag: string

  Opaque identifier assigned by the origin server to a specific version of a resource.

• Location: string

  Location of the resource.

Body ()

Root Schema : schema

Match All

Show Source

• allOf Review

  A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.

{
    "allOf":[
        {
            "$ref":"#/definitions/Review"
        }
    ]
}

Nested Schema : Review

A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Review-allOf[1]

{
    "description":"<p>A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, <em>auto approved</em> requests do not need a review. An <em>administrator approval</em> requires one administrator to review the request.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "decision":{
                    "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "comment":{
                    "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "createdAt":{
                    "description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "reviewedBy":{
                    "description":"<p>Get the details of the user or client application that created the review.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : SingularResource

Type: object

All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

Show Source

• links(optional): array links

  HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

{
    "description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        }
    }
}

Nested Schema : Review-allOf[1]

Type: object

Show Source

• comment(optional): string
  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.

• createdAt(optional): string(date-time)

  Date and time that the review was created. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

• decision(optional): string

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

  Valid values are:

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

• id(optional): integer(int32)

  Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• reviewedBy(optional): reviewedBy

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

{
    "properties":{
        "id":{
            "description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "decision":{
            "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "comment":{
            "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "createdAt":{
            "description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "reviewedBy":{
            "description":"<p>Get the details of the user or client application that created the review.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        }
    }
}

Nested Schema : links

Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object Link

  REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

Nested Schema : Link

Type: object

REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string

  The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the templated property must be set to true.

• mediaType(optional): string

  Media type, as defined by RFC 2046, describing the link target.

• method(optional): string

  HTTP method for requesting the target of the link.

  Valid values are:

  • OPTIONS - HTTP OPTIONS
  • HEAD - HTTP HEAD
  • GET - HTTP GET
  • POST - HTTP POST
  • PUT - HTTP PUT
  • PATCH - HTTP PATCH
  • DELETE - HTTP DELETE

• profile(optional): string(uri)

  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.

• rel(optional): string

  Name of the link relation that, in addition to the type property, can be used to retrieve link details.

• templated(optional): boolean

  Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the property is not present.

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

Nested Schema : reviewedBy

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

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>Get the details of the user or client application that created the review.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : Identity

Discriminator: type

Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

Introduced in release 20.3.1.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Identity-allOf[1]

{
    "description":"<p>Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.</p><small>Introduced in release 20.3.1.</small>",
    "discriminator":"type",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "type":{
                    "description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "id":{
                    "description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "displayName":{
                    "description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "roles":{
                    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : Identity-allOf[1]

Type: object

Show Source

• displayName(optional): string

  Human-readable display name.

  Introduced in release 20.3.1.
• id(optional): string

  An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 20.3.1.
• name(optional): string

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

  Introduced in release 20.3.1.
• roles(optional): array roles

  Roles.

  Valid values are:

  • CECServiceAdministrator - Service Administrator

  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator

  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator

  • Create new content types and publish items
  • CECStandardUser - Standard User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User

  Reserved for future use.

  • CECIntegrationUser - Integration User

  Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

  • CECSitesVisitor - Sites Visitor

  Access sites restricted to visitors.

  Introduced in release 21.10.2.
• type(optional): string

  Type of Identity. Valid values are: user, service, application, unknown.

  Introduced in release 20.3.1.

{
    "properties":{
        "type":{
            "description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "id":{
            "description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "roles":{
            "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : roles

Type: array

Roles.

Valid values are:

• CECServiceAdministrator - Service Administrator

• Assign user enumerates
• Change user passwords and challenge questions
• Configure, monitor, and manage service instances
• CECSitesAdministrator - Sites Administrator

• Create sites, templates, themes or components
• CECRepositoryAdministrator - Repository Administrator
• CECDeveloperUser - Developer User
• CECContentAdministrator - Content Administrator

• Create new content types and publish items
• CECStandardUser - Standard User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• View and interact with content items in sites
• Manage and view custom properties and edit values
• CECEnterpriseUser - Enterprise User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Digital Assets
• Content Items (editorial content management)
• Create, manage, view, and interact with content items
• Collections
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• Manage and view custom properties and edit values
• CECExternalUser - External User

Reserved for future use.

• CECIntegrationUser - Integration User

Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

• CECSitesVisitor - Sites Visitor

Access sites restricted to visitors.

Introduced in release 21.10.2.

Show Source

• Array of: string

{
    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response ()

{
    "id":0,
    "decision":"approved",
    "comment":"Site request looks good, approved.",
    "createdAt":"2019-06-01T06:44:17.000Z"
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• allOf ReviewRejectedExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/ReviewRejectedExceptionDetail"
        }
    ]
}

Nested Schema : ReviewRejectedExceptionDetail

Match All

Show Source

• object ExceptionDetail

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

• object ReviewRejectedExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "request":{
                    "description":"<p>Details of the request for which the review was rejected.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Request"
                        }
                    ]
                }
            }
        }
    ]
}

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

• detail(optional): string

  Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.

• instance(optional): string(uri)

  URI to the link that provides more detail about the error.

• o:errorCode(optional): string

  Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the title or detail.

• o:errorDetails(optional): array o:errorDetails

  Multiple errors can be organized in a hierarchical structure.

• o:errorPath(optional): string

  XPath or JSON path to indicate where the error occurs.

• status(optional): integer(int32)

  Corresponding HTTP status code for the error.

• title(optional): string

  Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the o:errorCode for this purpose.

• type(optional): string(uri)

  Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : ReviewRejectedExceptionDetail-allOf[1]

Type: object

Show Source

• request(optional): request

  Details of the request for which the review was rejected.

{
    "properties":{
        "request":{
            "description":"<p>Details of the request for which the review was rejected.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Request"
                }
            ]
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object ExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

Nested Schema : request

Details of the request for which the review was rejected.

Match All

Show Source

• allOf Request
  Discriminator: requestType

  A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.

{
    "description":"<p>Details of the request for which the review was rejected.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Request"
        }
    ]
}

Nested Schema : Request

Discriminator: requestType

A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Request-allOf[1]

{
    "description":"<p>A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more <em>reviews</em> to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.</p>",
    "discriminator":"requestType",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "requestType":{
                    "description":"<p>Type of <em>Request</em>. Valid values are: <code>SiteRequest</code>, <code>CopySiteRequest</code>.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "id":{
                    "description":"<p>Globally unique immutable identifier for a request.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "minimal",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "isDeleted":{
                    "description":"<p>Indicates that the request is has been marked as soft deleted.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "justification":{
                    "description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "reviews":{
                    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Review</em> elements.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Review"
                                    }
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "status":{
                    "description":"<p>Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "job":{
                    "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "properties":{
                        "links":{
                            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Link"
                                    }
                                ]
                            }
                        },
                        "context":{
                            "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"string"
                        },
                        "startTime":{
                            "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string",
                            "format":"date-time"
                        },
                        "endTime":{
                            "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string",
                            "format":"date-time"
                        },
                        "progress":{
                            "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string"
                        },
                        "completed":{
                            "description":"<p>Whether the asynchronous job is completed or not.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"boolean"
                        },
                        "requestStatus":{
                            "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int32"
                        },
                        "message":{
                            "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
                            "x-multiLingual":true,
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string"
                        },
                        "completedPercentage":{
                            "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int32"
                        },
                        "intervalToPoll":{
                            "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int64"
                        },
                        "error":{
                            "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"object"
                        },
                        "result":{
                            "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "allOf":[
                                {
                                    "$ref":"#/definitions/HttpResponse"
                                }
                            ]
                        }
                    },
                    "required":[
                        "progress",
                        "completed"
                    ]
                },
                "failure":{
                    "description":"<p>If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"object"
                },
                "createdBy":{
                    "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "createdAt":{
                    "description":"<p>Date and time the request was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "lastModifiedAt":{
                    "description":"<p>Date and time the request was last updated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "original":{
                    "description":"<p>Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This <em>forked</em> request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.</p>",
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "revision":{
                    "description":"<p>Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "policy":{
                    "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Policy"
                        }
                    ]
                },
                "approvers":{
                    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
                    "x-queryable":true,
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                }
            }
        }
    ]
}

Nested Schema : SingularResource

Type: object

All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

Show Source

• links(optional): array links

  HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

{
    "description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        }
    }
}

Nested Schema : Request-allOf[1]

Type: object

Show Source

• approvers(optional): object approvers

  List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.

  Introduced in release 19.3.3.
• createdAt(optional): string(date-time)

  Date and time the request was created. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

• createdBy(optional): createdBy

  Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.

• failure(optional): object failure

  If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.

• id(optional): string

  Globally unique immutable identifier for a request.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• isDeleted(optional): boolean

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

• job(optional): object job

  When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is blocked - blocked waiting for approval. A completed request will also have a job status that is completed.

• justification(optional): string
  Maximum Length: 1000

  The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.

• lastModifiedAt(optional): string(date-time)

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

• original(optional): string

  Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This forked request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.

• policy(optional): policy

  Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.

  Introduced in release 19.2.1.
• requestType(optional): string

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

• reviews(optional): object reviews

  Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.

• revision(optional): integer(int64)

  Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong ETag value for this resource.

• status(optional): string

  Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.

  Valid values are:

  • pending - Request is pending approval
  • rejected - Request has not been approved
  • approved - Request has been approved
  • failed - Request has been approved but failed during the request processing
  • complete - Request has been approved and is now complete

{
    "properties":{
        "requestType":{
            "description":"<p>Type of <em>Request</em>. Valid values are: <code>SiteRequest</code>, <code>CopySiteRequest</code>.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "id":{
            "description":"<p>Globally unique immutable identifier for a request.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "minimal",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "isDeleted":{
            "description":"<p>Indicates that the request is has been marked as soft deleted.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "justification":{
            "description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "reviews":{
            "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Review</em> elements.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Review"
                            }
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "status":{
            "description":"<p>Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "job":{
            "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "properties":{
                "links":{
                    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Link"
                            }
                        ]
                    }
                },
                "context":{
                    "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "startTime":{
                    "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "endTime":{
                    "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "progress":{
                    "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completed":{
                    "description":"<p>Whether the asynchronous job is completed or not.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "requestStatus":{
                    "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "message":{
                    "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
                    "x-multiLingual":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completedPercentage":{
                    "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "intervalToPoll":{
                    "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "error":{
                    "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"object"
                },
                "result":{
                    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/HttpResponse"
                        }
                    ]
                }
            },
            "required":[
                "progress",
                "completed"
            ]
        },
        "failure":{
            "description":"<p>If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object"
        },
        "createdBy":{
            "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "createdAt":{
            "description":"<p>Date and time the request was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedAt":{
            "description":"<p>Date and time the request was last updated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "original":{
            "description":"<p>Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This <em>forked</em> request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.</p>",
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "revision":{
            "description":"<p>Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "policy":{
            "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Policy"
                }
            ]
        },
        "approvers":{
            "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        }
    }
}

Nested Schema : links

Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object Link

  REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

Nested Schema : Link

Type: object

REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string

  The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the templated property must be set to true.

• mediaType(optional): string

  Media type, as defined by RFC 2046, describing the link target.

• method(optional): string

  HTTP method for requesting the target of the link.

  Valid values are:

  • OPTIONS - HTTP OPTIONS
  • HEAD - HTTP HEAD
  • GET - HTTP GET
  • POST - HTTP POST
  • PUT - HTTP PUT
  • PATCH - HTTP PATCH
  • DELETE - HTTP DELETE

• profile(optional): string(uri)

  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.

• rel(optional): string

  Name of the link relation that, in addition to the type property, can be used to retrieve link details.

• templated(optional): boolean

  Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the property is not present.

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

Nested Schema : approvers

Type: object

List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.

Introduced in release 19.3.3.

Show Source

• items: array items

  Collection of Request Approvers Member elements.

  Introduced in release 19.3.3.

{
    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-queryable":true,
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Match All

Show Source

• allOf CollectionResource

  All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

{
    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-queryable":true,
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : createdBy

Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : failure

Type: object

If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.

Nested Schema : job

Type: object

When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is blocked - blocked waiting for approval. A completed request will also have a job status that is completed.

Show Source

• completed: boolean

  Whether the asynchronous job is completed or not.

• completedPercentage(optional): integer(int32)

  A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.

• context(optional): string

  Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.

• endTime(optional): string(date-time)

  Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

• error(optional): object error

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

• intervalToPoll(optional): integer(int64)

  A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.

• links(optional): array links

  HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

• message(optional): string

  Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.

• progress: string

  The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: succeeded, failed, aborted. The value blocked means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: pending, processing, paused.

  Valid values are:

  • pending - Request is waiting to run
  • processing - Request is running
  • succeeded - Request has completed successfully
  • failed - Request has failed

  A processing request failed before it was completed.

  • aborted - Request was aborted

  A processing request was aborted before it was completed.

  • paused - Request was running, but is now paused
  • blocked - Request is blocked

  Request requires action, such as waiting for a human to approve something.

• requestStatus(optional): integer(int32)

  HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.

• result(optional): result

  It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.

• startTime(optional): string(date-time)

  Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

{
    "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "context":{
            "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "progress":{
            "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completed":{
            "description":"<p>Whether the asynchronous job is completed or not.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "requestStatus":{
            "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completedPercentage":{
            "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "intervalToPoll":{
            "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "error":{
            "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object"
        },
        "result":{
            "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/HttpResponse"
                }
            ]
        }
    },
    "required":[
        "progress",
        "completed"
    ]
}

Nested Schema : policy

Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.

Introduced in release 19.2.1.

Match All

Show Source

• allOf Policy

  A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.

  A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.

  A policy can be marked as inactive which prevents the operation from being performed or requested.

{
    "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
    "x-queryable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Policy"
        }
    ]
}

Nested Schema : reviews

Type: object

Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.

Show Source

• items: array items

  Collection of Review elements.

{
    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Review</em> elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Review"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Match All

Show Source

• allOf CollectionResource

  All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

{
    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Review</em> elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Review"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Collection of Request Approvers Member elements.

Introduced in release 19.3.3.

Show Source

• Array of: object items

{
    "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

Nested Schema : CollectionResource

All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object CollectionResource-allOf[1]

{
    "description":"<p>All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "totalResults":{
                    "description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "limit":{
                    "description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "count":{
                    "description":"<p>Total number of resources in the response.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "hasMore":{
                    "description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"boolean"
                },
                "offset":{
                    "description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

Nested Schema : CollectionResource-allOf[1]

Type: object

Show Source

• count(optional): integer(int32)

  Total number of resources in the response.

• hasMore(optional): boolean

  Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.

• limit(optional): integer(int32)

  Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.

• offset(optional): integer(int64)

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

• totalResults(optional): integer(int64)

  Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the totalResults parameter is supported and is set to true by the client.

{
    "properties":{
        "totalResults":{
            "description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "description":"<p>Total number of resources in the response.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"boolean"
        },
        "offset":{
            "description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string

  Display name for the user, client application or group.

  Introduced in release 19.3.3.
• group(optional): group

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

  Introduced in release 19.3.3.
• groupType(optional): string

  If the member is a group, then the type of group is specified. If the member is a user this field is not present.

  Valid values are:

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

  Introduced in release 20.1.1.
• id: string

  Identifier for the user, client application or group member.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 19.3.3.
• isExternalUser(optional): boolean

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

  Introduced in release 21.10.2.
• name: string

  Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

  Introduced in release 19.3.3.
• type: string

  Indicates the member is a user, client application or group.

  Valid values are:

  • user - Member is a user or a client application. No distinction is made between a member that is a user or a

  member that is a client application.

  • group - Member is a group

  Introduced in release 19.3.3.
• user(optional): user

  User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

  Introduced in release 19.3.3.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

Nested Schema : group

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

Introduced in release 19.3.3.

Match All

Show Source

• allOf Group

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

  Introduced in release 19.3.1.

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.3.

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : Group

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

Introduced in release 19.3.1.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Group-allOf[1]

{
    "description":"<p>A group is a collection of users and groups. A group has a human readable group name.</p><small>Introduced in release 19.3.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "type":{
                    "description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "groupName":{
                    "description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "displayName":{
                    "description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "roles":{
                    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : Group-allOf[1]

Type: object

Show Source

• displayName(optional): string

  Human-readable name for the group.

  Introduced in release 19.3.1.
• groupName(optional): string

  Group name that is unique within the service instance.

  Introduced in release 19.3.1.
• id(optional): string

  Unique identifer for the group.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 19.3.1.
• roles(optional): array roles

  Roles.

  Valid values are:

  • CECServiceAdministrator - Service Administrator

  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator

  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator

  • Create new content types and publish items
  • CECStandardUser - Standard User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User

  Reserved for future use.

  • CECIntegrationUser - Integration User

  Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

  • CECSitesVisitor - Sites Visitor

  Access sites restricted to visitors.

  Introduced in release 21.10.2.
• type(optional): string

  Type of the group.

  Valid values are:

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

  Introduced in release 19.3.1.

{
    "properties":{
        "id":{
            "description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupName":{
            "description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "roles":{
            "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : roles

Type: array

Roles.

Valid values are:

• CECServiceAdministrator - Service Administrator

• Assign user enumerates
• Change user passwords and challenge questions
• Configure, monitor, and manage service instances
• CECSitesAdministrator - Sites Administrator

• Create sites, templates, themes or components
• CECRepositoryAdministrator - Repository Administrator
• CECDeveloperUser - Developer User
• CECContentAdministrator - Content Administrator

• Create new content types and publish items
• CECStandardUser - Standard User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• View and interact with content items in sites
• Manage and view custom properties and edit values
• CECEnterpriseUser - Enterprise User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Digital Assets
• Content Items (editorial content management)
• Create, manage, view, and interact with content items
• Collections
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• Manage and view custom properties and edit values
• CECExternalUser - External User

Reserved for future use.

• CECIntegrationUser - Integration User

Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

• CECSitesVisitor - Sites Visitor

Access sites restricted to visitors.

Introduced in release 21.10.2.

Show Source

• Array of: string

{
    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Identity

Discriminator: type

Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

Introduced in release 20.3.1.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Identity-allOf[1]

{
    "description":"<p>Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.</p><small>Introduced in release 20.3.1.</small>",
    "discriminator":"type",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "type":{
                    "description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "id":{
                    "description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "displayName":{
                    "description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "roles":{
                    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : Identity-allOf[1]

Type: object

Show Source

• displayName(optional): string

  Human-readable display name.

  Introduced in release 20.3.1.
• id(optional): string

  An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 20.3.1.
• name(optional): string

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

  Introduced in release 20.3.1.
• roles(optional): array roles

  Roles.

  Valid values are:

  • CECServiceAdministrator - Service Administrator

  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator

  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator

  • Create new content types and publish items
  • CECStandardUser - Standard User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User

  Reserved for future use.

  • CECIntegrationUser - Integration User

  Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

  • CECSitesVisitor - Sites Visitor

  Access sites restricted to visitors.

  Introduced in release 21.10.2.
• type(optional): string

  Type of Identity. Valid values are: user, service, application, unknown.

  Introduced in release 20.3.1.

{
    "properties":{
        "type":{
            "description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "id":{
            "description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "roles":{
            "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : roles

Type: array

Roles.

Valid values are:

• CECServiceAdministrator - Service Administrator

• Assign user enumerates
• Change user passwords and challenge questions
• Configure, monitor, and manage service instances
• CECSitesAdministrator - Sites Administrator

• Create sites, templates, themes or components
• CECRepositoryAdministrator - Repository Administrator
• CECDeveloperUser - Developer User
• CECContentAdministrator - Content Administrator

• Create new content types and publish items
• CECStandardUser - Standard User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• View and interact with content items in sites
• Manage and view custom properties and edit values
• CECEnterpriseUser - Enterprise User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Digital Assets
• Content Items (editorial content management)
• Create, manage, view, and interact with content items
• Collections
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• Manage and view custom properties and edit values
• CECExternalUser - External User

Reserved for future use.

• CECIntegrationUser - Integration User

Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

• CECSitesVisitor - Sites Visitor

Access sites restricted to visitors.

Introduced in release 21.10.2.

Show Source

• Array of: string

{
    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : error

Type: object

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

Nested Schema : links

Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : result

It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.

Match All

Show Source

• object HttpResponse

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

{
    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/HttpResponse"
        }
    ]
}

Nested Schema : items

Match All

Show Source

• object Link

  REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

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

• headers(optional): array headers

  HTTP response headers.

• status(optional): object status

  HTTP status code response value and reason.

{
    "description":"<p>Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.</p>",
    "properties":{
        "status":{
            "description":"<p>HTTP status code response value and reason.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "code":{
                    "description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "reason":{
                    "description":"<p>Short, human-readable summary of the status code.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            },
            "required":[
                "code",
                "reason"
            ]
        },
        "headers":{
            "description":"<p>HTTP response headers.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"<p>Header name.</p>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "value":{
                        "description":"<p>Header value.</p>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    }
                },
                "required":[
                    "name"
                ]
            }
        }
    }
}

Nested Schema : headers

Type: array

HTTP response headers.

Show Source

• Array of: object items

{
    "description":"<p>HTTP response headers.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"<p>Header name.</p>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "value":{
                "description":"<p>Header value.</p>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            }
        },
        "required":[
            "name"
        ]
    }
}

Nested Schema : status

Type: object

HTTP status code response value and reason.

Show Source

• code: integer(int32)

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

• reason: string

  Short, human-readable summary of the status code.

{
    "description":"<p>HTTP status code response value and reason.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "code":{
            "description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "reason":{
            "description":"<p>Short, human-readable summary of the status code.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Nested Schema : items

Type: object

Show Source

• name: string

  Header name.

• value(optional): string

  Header value.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"<p>Header name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "value":{
            "description":"<p>Header value.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : Policy

A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.

A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.

A policy can be marked as inactive which prevents the operation from being performed or requested.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Policy-allOf[1]

{
    "description":"<p>A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.</p><p>A policy is associated with a resource, for example a <em>site creation</em> policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.</p><p>A policy can be marked as <em>inactive</em> which prevents the operation from being performed or requested.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Globally unique identifier for a policy.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "minimal",
                        "basic"
                    ],
                    "type":"string"
                },
                "status":{
                    "description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "approvalType":{
                    "description":"<p>When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "approvers":{
                    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "accessType":{
                    "description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "access":{
                    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "security":{
                    "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SecurityPolicy"
                        }
                    ]
                },
                "repository":{
                    "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Repository"
                        }
                    ]
                },
                "localizationPolicyAllowed":{
                    "description":"<p>If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "sitePrefixAllowed":{
                    "description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "expiration":{
                    "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteExpirationPeriod"
                        }
                    ]
                },
                "revision":{
                    "description":"<p>Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

Nested Schema : Policy-allOf[1]

Type: object

Show Source

• access(optional): object access

  List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType of the policy is set to restricted.

  Introduced in release 19.3.1.
• accessType(optional): string

  Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.

  Valid values are:

  • everyone - Policy, when active, is applicable to everyone
  • restricted - Policy, when active, is applicable to users that are part of the access list

  Introduced in release 19.3.1.
• approvalType(optional): string

  When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.

  Valid values are:

  • automatic - A request will automatically be approved without any human approval process involved
  • admin - Any user with the site administrator role can approve the associated request
  • named - Site creation will require approval from one user that is a member of the approvers list associated with the policy

• approvers(optional): object approvers

  List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.

  Introduced in release 19.3.3.
• expiration(optional): expiration

  When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

  Introduced in release 19.4.1.
• id(optional): string

  Globally unique identifier for a policy.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• localizationPolicyAllowed(optional): boolean

  If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.

  Introduced in release 19.2.3.
• repository(optional): repository

  When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

  Introduced in release 19.2.3.
• revision(optional): integer(int64)

  Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong ETag value for this resource.

• security(optional): security

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

• sitePrefixAllowed(optional): boolean

  If true, a request for a new site can include an explicit site prefix. If false, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.

  Introduced in release 19.2.3.
• status(optional): string

  The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is inactive then the operation cannot be performed. If the policy status is active then the operation can be performed. For example, for a policy associated with a site template, a status of active means that users can create sites from that site template.

  Valid values are:

  • inactive - Policy that is marked as inactive means the associated operation cannot be requested
  • active - Policy that is marked as active means the associated operation can be requested

{
    "properties":{
        "id":{
            "description":"<p>Globally unique identifier for a policy.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "minimal",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "approvalType":{
            "description":"<p>When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "approvers":{
            "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "accessType":{
            "description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "access":{
            "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "security":{
            "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SecurityPolicy"
                }
            ]
        },
        "repository":{
            "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Repository"
                }
            ]
        },
        "localizationPolicyAllowed":{
            "description":"<p>If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "sitePrefixAllowed":{
            "description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "expiration":{
            "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteExpirationPeriod"
                }
            ]
        },
        "revision":{
            "description":"<p>Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : access

Type: object

List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType of the policy is set to restricted.

Introduced in release 19.3.1.

Show Source

• items: array items

  Collection of Policy Access Member elements.

  Introduced in release 19.3.1.

{
    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Match All

Show Source

• allOf CollectionResource

  All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

{
    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : approvers

Type: object

List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.

Introduced in release 19.3.3.

Show Source

• items: array items

  Collection of Policy Approvers Member elements.

  Introduced in release 19.3.3.

{
    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Match All

Show Source

• allOf CollectionResource

  All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

{
    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : expiration

When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

Introduced in release 19.4.1.

Match All

Show Source

• object SiteExpirationPeriod

  Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

  Introduced in release 19.4.1.

{
    "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteExpirationPeriod"
        }
    ]
}

Nested Schema : repository

When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

Introduced in release 19.2.3.

Match All

Show Source

• allOf Repository

  Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.

  A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.

{
    "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Repository"
        }
    ]
}

Nested Schema : security

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

Match All

Show Source

• object SecurityPolicy

  The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.

{
    "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SecurityPolicy"
        }
    ]
}

Nested Schema : items

Type: array

Collection of Policy Access Member elements.

Introduced in release 19.3.1.

Show Source

• Array of: object items

{
    "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string

  Display name for the user, client application or group.

  Introduced in release 19.3.1.
• group(optional): group

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

  Introduced in release 19.3.1.
• groupType(optional): string

  If the member is a group, then the type of group is specified. If the member is a user this field is not present.

  Valid values are:

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

  Introduced in release 20.1.1.
• id: string

  Identifier for the user, client application or group member.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 19.3.1.
• isExternalUser(optional): boolean

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

  Introduced in release 21.10.2.
• name: string

  Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

  Introduced in release 19.3.1.
• type: string

  Indicates the member is a user, client application or group.

  Valid values are:

  • user - Member is a user or a client application. No distinction is made between a member that is a user or a

  member that is a client application.

  • group - Member is a group

  Introduced in release 19.3.1.
• user(optional): user

  User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

  Introduced in release 19.3.1.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

Nested Schema : group

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

Introduced in release 19.3.1.

Match All

Show Source

• allOf Group

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

  Introduced in release 19.3.1.

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.1.

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : items

Type: array

Collection of Policy Approvers Member elements.

Introduced in release 19.3.3.

Show Source

• Array of: object items

{
    "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string

  Display name for the user, client application or group.

  Introduced in release 19.3.3.
• group(optional): group

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

  Introduced in release 19.3.3.
• groupType(optional): string

  If the member is a group, then the type of group is specified. If the member is a user this field is not present.

  Valid values are:

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

  Introduced in release 20.1.1.
• id: string

  Identifier for the user, client application or group member.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 19.3.3.
• isExternalUser(optional): boolean

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

  Introduced in release 21.10.2.
• name: string

  Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

  Introduced in release 19.3.3.
• type: string

  Indicates the member is a user, client application or group.

  Valid values are:

  • user - Member is a user or a client application. No distinction is made between a member that is a user or a

  member that is a client application.

  • group - Member is a group

  Introduced in release 19.3.3.
• user(optional): user

  User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

  Introduced in release 19.3.3.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

Nested Schema : group

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

Introduced in release 19.3.3.

Match All

Show Source

• allOf Group

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

  Introduced in release 19.3.1.

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.3.

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : SiteExpirationPeriod

Type: object

Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

Introduced in release 19.4.1.

Show Source

• amount(optional): integer(int32)

  Amount of time used to measure site expiration.

  Introduced in release 19.4.1.
• unit(optional): string

  Unit of time used to measure site expiration.

  Valid values are:

  • months - Expiration expressed in the number of months
  • years - Expiration expressed in the number of years

  Introduced in release 19.4.1.

{
    "description":"<p>Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.</p><small>Introduced in release 19.4.1.</small>",
    "properties":{
        "amount":{
            "description":"<p>Amount of time used to measure site expiration.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "unit":{
            "description":"<p>Unit of time used to measure site expiration.</p><p>Valid values are:\n<ul><li> <code>months</code> - Expiration expressed in the number of months</li><li> <code>years</code> - Expiration expressed in the number of years</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : Repository

Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.

A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Repository-allOf[1]

{
    "description":"<p>Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.</p><p>A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "minimal",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Short human-readable name to identify the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "description":{
                    "description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "createdBy":{
                    "description":"<p>User that created the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "createdDate":{
                    "description":"<p>Date and time the repository was created.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "updatedBy":{
                    "description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "updatedDate":{
                    "description":"<p>Date and time the repository was last updated.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "autoTagEnabled":{
                    "description":"<p>Whether auto tagging is enabled for the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "contentTypes":{
                    "description":"<p>Content types associated with the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ContentTypeId"
                            }
                        ]
                    }
                },
                "channels":{
                    "description":"<p>Channels associated with the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ChannelId"
                            }
                        ]
                    }
                },
                "defaultLanguage":{
                    "description":"<p>Default language of the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "languageOptions":{
                    "description":"<p>Language options for the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "roleName":{
                    "description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : Repository-allOf[1]

Type: object

Show Source

• autoTagEnabled(optional): boolean

  Whether auto tagging is enabled for the repository.

• channels(optional): array channels

  Channels associated with the repository.

• contentTypes(optional): array contentTypes

  Content types associated with the repository.

• createdBy(optional): string

  User that created the repository.

• createdDate(optional): createdDate

  Date and time the repository was created.

• defaultLanguage(optional): string

  Default language of the repository.

• description(optional): string

  Human-readable description of the repository to give consumers an idea of what content this repository contains.

• id(optional): string

  Unique identifier for the repository.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• languageOptions(optional): array languageOptions

  Language options for the repository.

• name(optional): string

  Short human-readable name to identify the repository.

• roleName(optional): string

  The role the authenticated user has within the repository.

  Valid values are:

  • owner - Owner of the resource
  • custom - Custom role
  • manager - Manager role
  • contributor - Contributor role
  • downloader - Downloader role
  • viewer - Viewer role

• updatedBy(optional): string

  User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.

• updatedDate(optional): updatedDate

  Date and time the repository was last updated.

{
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "minimal",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short human-readable name to identify the repository.</p>",
            "x-returnedIn":[
                "representation",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "createdBy":{
            "description":"<p>User that created the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "createdDate":{
            "description":"<p>Date and time the repository was created.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "updatedBy":{
            "description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "updatedDate":{
            "description":"<p>Date and time the repository was last updated.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "autoTagEnabled":{
            "description":"<p>Whether auto tagging is enabled for the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "contentTypes":{
            "description":"<p>Content types associated with the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ContentTypeId"
                    }
                ]
            }
        },
        "channels":{
            "description":"<p>Channels associated with the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ChannelId"
                    }
                ]
            }
        },
        "defaultLanguage":{
            "description":"<p>Default language of the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "languageOptions":{
            "description":"<p>Language options for the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        }
    }
}

Nested Schema : channels

Type: array

Channels associated with the repository.

Show Source

• Array of: items

{
    "description":"<p>Channels associated with the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ChannelId"
            }
        ]
    }
}

Nested Schema : contentTypes

Type: array

Content types associated with the repository.

Show Source

• Array of: items

{
    "description":"<p>Content types associated with the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ContentTypeId"
            }
        ]
    }
}

Nested Schema : createdDate

Date and time the repository was created.

Match All

Show Source

• object DateTimeZone

  Date, time and time zone.

{
    "description":"<p>Date and time the repository was created.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

Nested Schema : languageOptions

Type: array

Language options for the repository.

Show Source

• Array of: string

{
    "description":"<p>Language options for the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : updatedDate

Date and time the repository was last updated.

Match All

Show Source

• object DateTimeZone

  Date, time and time zone.

{
    "description":"<p>Date and time the repository was last updated.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

Nested Schema : items

Match All

Show Source

• object ChannelId

  Channel identifier.

{
    "allOf":[
        {
            "$ref":"#/definitions/ChannelId"
        }
    ]
}

Nested Schema : ChannelId

Type: object

Channel identifier.

Show Source

• id(optional): string

  Unique identifier for the repository.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• name(optional): string

  Short unique human-readable name to identify the channel.

{
    "description":"<p>Channel identifier.</p>",
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short unique human-readable name to identify the channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : items

Match All

Show Source

• object ContentTypeId

  Content type identifier.

{
    "allOf":[
        {
            "$ref":"#/definitions/ContentTypeId"
        }
    ]
}

Nested Schema : ContentTypeId

Type: object

Content type identifier.

Show Source

• name(optional): string

  Content type name.

{
    "description":"<p>Content type identifier.</p>",
    "properties":{
        "name":{
            "description":"<p>Content type name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : DateTimeZone

Type: object

Date, time and time zone.

Show Source

• description(optional): string

  Description of the date, time and time zone information.

• timezone(optional): string

  Timezone in Olson database format.

• value(optional): string(date-time)

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

{
    "description":"<p>Date, time and time zone.</p>",
    "properties":{
        "value":{
            "description":"<p>Date in ISO 8601 format. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"<p>Timezone in Olson database format.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Description of the date, time and time zone information.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : SecurityPolicy

Type: object

The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.

Show Source

• appliesTo(optional): string

  Define which types of users may access a site. Can include all users or be restricted to named users only.

  Valid values are:

  • named - Only named users within a specified level can access
  • all - All users within a specified level can access

• level(optional): string

  Maximum open security level that can be set on a site.

  Valid values are:

  • service - Only service users
  • cloud - Only cloud users who can sign in to your domain
  • everyone - Anyone without signing in

{
    "description":"<p>The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.</p>",
    "properties":{
        "level":{
            "description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "appliesTo":{
            "description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Collection of Review elements.

Show Source

• Array of: items

{
    "description":"<p>Collection of <em>Review</em> elements.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Review"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• allOf Review

  A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.

{
    "allOf":[
        {
            "$ref":"#/definitions/Review"
        }
    ]
}

Nested Schema : Review

A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Review-allOf[1]

{
    "description":"<p>A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, <em>auto approved</em> requests do not need a review. An <em>administrator approval</em> requires one administrator to review the request.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "decision":{
                    "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "comment":{
                    "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "createdAt":{
                    "description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "reviewedBy":{
                    "description":"<p>Get the details of the user or client application that created the review.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : Review-allOf[1]

Type: object

Show Source

• comment(optional): string
  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.

• createdAt(optional): string(date-time)

  Date and time that the review was created. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

• decision(optional): string

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

  Valid values are:

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

• id(optional): integer(int32)

  Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• reviewedBy(optional): reviewedBy

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

{
    "properties":{
        "id":{
            "description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "decision":{
            "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "comment":{
            "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "createdAt":{
            "description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "reviewedBy":{
            "description":"<p>Get the details of the user or client application that created the review.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        }
    }
}

Nested Schema : reviewedBy

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

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>Get the details of the user or client application that created the review.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Example Response (Review Rejected)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Review Rejected",
    "status":"400",
    "detail":"Review has been rejected because the request is already approved, rejected or does not require a review to be approved.",
    "o:errorCode":"OCE-SITEMGMT-009011"
}

401 Response

Unauthorized

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• allOf ReviewNotAllowedExceptionDetail
  Introduced in release 19.3.1.

{
    "allOf":[
        {
            "$ref":"#/definitions/ReviewNotAllowedExceptionDetail"
        }
    ]
}

Nested Schema : ReviewNotAllowedExceptionDetail

Introduced in release 19.3.1.

Match All

Show Source

• object ExceptionDetail

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

• object ReviewNotAllowedExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.3.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "request":{
                    "description":"<p>Request for which reviews cannot be added for the authenticated user.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

• detail(optional): string

  Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.

• instance(optional): string(uri)

  URI to the link that provides more detail about the error.

• o:errorCode(optional): string

  Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the title or detail.

• o:errorDetails(optional): array o:errorDetails

  Multiple errors can be organized in a hierarchical structure.

• o:errorPath(optional): string

  XPath or JSON path to indicate where the error occurs.

• status(optional): integer(int32)

  Corresponding HTTP status code for the error.

• title(optional): string

  Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the o:errorCode for this purpose.

• type(optional): string(uri)

  Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : ReviewNotAllowedExceptionDetail-allOf[1]

Type: object

Show Source

• request(optional): string

  Request for which reviews cannot be added for the authenticated user.

  Introduced in release 19.3.1.

{
    "properties":{
        "request":{
            "description":"<p>Request for which reviews cannot be added for the authenticated user.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object ExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

Example Response (Review Not Allowed)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Review Not Allowed",
    "status":"403",
    "detail":"You do not have permissions to add reviews to this request.",
    "o:errorCode":"OCE-SITEMGMT-009038",
    "request":{
        "id":"e77229e8-1f44-4c27-bacb-9a99b7c77af7"
    }
}

404 Response

Not Found

Headers

• Cache-Control: string

  Directives for caching mechanisms.

• Content-Length: string

  Size of the response body.

• Content-Type: string

  Content type of the response.

Body ()

Root Schema : schema

Match All

Show Source

• allOf RequestNotFoundExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/RequestNotFoundExceptionDetail"
        }
    ]
}

Nested Schema : RequestNotFoundExceptionDetail

Match All

Show Source

• object ExceptionDetail

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

• object RequestNotFoundExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "request":{
                    "description":"<p>Request that does not exist or is not visible to the authenticated user.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

• detail(optional): string

  Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.

• instance(optional): string(uri)

  URI to the link that provides more detail about the error.

• o:errorCode(optional): string

  Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the title or detail.

• o:errorDetails(optional): array o:errorDetails

  Multiple errors can be organized in a hierarchical structure.

• o:errorPath(optional): string

  XPath or JSON path to indicate where the error occurs.

• status(optional): integer(int32)

  Corresponding HTTP status code for the error.

• title(optional): string

  Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the o:errorCode for this purpose.

• type(optional): string(uri)

  Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : RequestNotFoundExceptionDetail-allOf[1]

Type: object

Show Source

• request(optional): string

  Request that does not exist or is not visible to the authenticated user.

{
    "properties":{
        "request":{
            "description":"<p>Request that does not exist or is not visible to the authenticated user.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object ExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

Example Response (Request Not Found)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Request Not Found",
    "status":"404",
    "detail":"Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.",
    "o:errorCode":"OCE-SITEMGMT-009001",
    "request":{
        "id":"e77229e8-1f44-4c27-bacb-9a99b7c77af7"
    }
}

406 Response

Not Acceptable

409 Response

Conflict

Body ()

Root Schema : schema

Match All

Show Source

• allOf InvalidRequestStatusExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/InvalidRequestStatusExceptionDetail"
        }
    ]
}

Nested Schema : InvalidRequestStatusExceptionDetail

Match All

Show Source

• object ExceptionDetail

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

• object InvalidRequestStatusExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "request":{
                    "description":"<p>Request on which the operation is being performed.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Request"
                        }
                    ]
                },
                "required":{
                    "description":"<p>Required status of the request for the operation to be valid.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

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

• detail(optional): string

  Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.

• instance(optional): string(uri)

  URI to the link that provides more detail about the error.

• o:errorCode(optional): string

  Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the title or detail.

• o:errorDetails(optional): array o:errorDetails

  Multiple errors can be organized in a hierarchical structure.

• o:errorPath(optional): string

  XPath or JSON path to indicate where the error occurs.

• status(optional): integer(int32)

  Corresponding HTTP status code for the error.

• title(optional): string

  Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the o:errorCode for this purpose.

• type(optional): string(uri)

  Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : InvalidRequestStatusExceptionDetail-allOf[1]

Type: object

Show Source

• request(optional): request

  Request on which the operation is being performed.

• required(optional): array required

  Required status of the request for the operation to be valid.

  Valid values are:

  • pending - Request is pending approval
  • rejected - Request has not been approved
  • approved - Request has been approved
  • failed - Request has been approved but failed during the request processing
  • complete - Request has been approved and is now complete

{
    "properties":{
        "request":{
            "description":"<p>Request on which the operation is being performed.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Request"
                }
            ]
        },
        "required":{
            "description":"<p>Required status of the request for the operation to be valid.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object ExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

Nested Schema : request

Request on which the operation is being performed.

Match All

Show Source

• allOf Request
  Discriminator: requestType

  A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.

{
    "description":"<p>Request on which the operation is being performed.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Request"
        }
    ]
}

Nested Schema : required

Type: array

Required status of the request for the operation to be valid.

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

Show Source

• Array of: string

{
    "description":"<p>Required status of the request for the operation to be valid.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Request

Discriminator: requestType

A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more reviews to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Request-allOf[1]

{
    "description":"<p>A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more <em>reviews</em> to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.</p>",
    "discriminator":"requestType",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "requestType":{
                    "description":"<p>Type of <em>Request</em>. Valid values are: <code>SiteRequest</code>, <code>CopySiteRequest</code>.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "id":{
                    "description":"<p>Globally unique immutable identifier for a request.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "minimal",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "isDeleted":{
                    "description":"<p>Indicates that the request is has been marked as soft deleted.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "justification":{
                    "description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "reviews":{
                    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Review</em> elements.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Review"
                                    }
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "status":{
                    "description":"<p>Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "job":{
                    "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "properties":{
                        "links":{
                            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Link"
                                    }
                                ]
                            }
                        },
                        "context":{
                            "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"string"
                        },
                        "startTime":{
                            "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string",
                            "format":"date-time"
                        },
                        "endTime":{
                            "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string",
                            "format":"date-time"
                        },
                        "progress":{
                            "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string"
                        },
                        "completed":{
                            "description":"<p>Whether the asynchronous job is completed or not.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"boolean"
                        },
                        "requestStatus":{
                            "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int32"
                        },
                        "message":{
                            "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
                            "x-multiLingual":true,
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string"
                        },
                        "completedPercentage":{
                            "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int32"
                        },
                        "intervalToPoll":{
                            "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int64"
                        },
                        "error":{
                            "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"object"
                        },
                        "result":{
                            "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "allOf":[
                                {
                                    "$ref":"#/definitions/HttpResponse"
                                }
                            ]
                        }
                    },
                    "required":[
                        "progress",
                        "completed"
                    ]
                },
                "failure":{
                    "description":"<p>If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"object"
                },
                "createdBy":{
                    "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "createdAt":{
                    "description":"<p>Date and time the request was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "lastModifiedAt":{
                    "description":"<p>Date and time the request was last updated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "original":{
                    "description":"<p>Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This <em>forked</em> request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.</p>",
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "revision":{
                    "description":"<p>Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "policy":{
                    "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Policy"
                        }
                    ]
                },
                "approvers":{
                    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
                    "x-queryable":true,
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                }
            }
        }
    ]
}

Nested Schema : SingularResource

Type: object

All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

Show Source

• links(optional): array links

  HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

{
    "description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        }
    }
}

Nested Schema : Request-allOf[1]

Type: object

Show Source

• approvers(optional): object approvers

  List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.

  Introduced in release 19.3.3.
• createdAt(optional): string(date-time)

  Date and time the request was created. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

• createdBy(optional): createdBy

  Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.

• failure(optional): object failure

  If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.

• id(optional): string

  Globally unique immutable identifier for a request.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• isDeleted(optional): boolean

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

• job(optional): object job

  When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is blocked - blocked waiting for approval. A completed request will also have a job status that is completed.

• justification(optional): string
  Maximum Length: 1000

  The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.

• lastModifiedAt(optional): string(date-time)

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

• original(optional): string

  Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This forked request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.

• policy(optional): policy

  Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.

  Introduced in release 19.2.1.
• requestType(optional): string

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

• reviews(optional): object reviews

  Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.

• revision(optional): integer(int64)

  Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong ETag value for this resource.

• status(optional): string

  Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.

  Valid values are:

  • pending - Request is pending approval
  • rejected - Request has not been approved
  • approved - Request has been approved
  • failed - Request has been approved but failed during the request processing
  • complete - Request has been approved and is now complete

{
    "properties":{
        "requestType":{
            "description":"<p>Type of <em>Request</em>. Valid values are: <code>SiteRequest</code>, <code>CopySiteRequest</code>.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "id":{
            "description":"<p>Globally unique immutable identifier for a request.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "minimal",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "isDeleted":{
            "description":"<p>Indicates that the request is has been marked as soft deleted.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "justification":{
            "description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "reviews":{
            "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Review</em> elements.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Review"
                            }
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "status":{
            "description":"<p>Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "job":{
            "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "properties":{
                "links":{
                    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Link"
                            }
                        ]
                    }
                },
                "context":{
                    "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "startTime":{
                    "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "endTime":{
                    "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "progress":{
                    "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completed":{
                    "description":"<p>Whether the asynchronous job is completed or not.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "requestStatus":{
                    "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "message":{
                    "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
                    "x-multiLingual":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completedPercentage":{
                    "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "intervalToPoll":{
                    "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "error":{
                    "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"object"
                },
                "result":{
                    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/HttpResponse"
                        }
                    ]
                }
            },
            "required":[
                "progress",
                "completed"
            ]
        },
        "failure":{
            "description":"<p>If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object"
        },
        "createdBy":{
            "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "createdAt":{
            "description":"<p>Date and time the request was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedAt":{
            "description":"<p>Date and time the request was last updated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "original":{
            "description":"<p>Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This <em>forked</em> request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.</p>",
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "revision":{
            "description":"<p>Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "policy":{
            "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Policy"
                }
            ]
        },
        "approvers":{
            "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        }
    }
}

Nested Schema : links

Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object Link

  REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

Nested Schema : Link

Type: object

REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string

  The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the templated property must be set to true.

• mediaType(optional): string

  Media type, as defined by RFC 2046, describing the link target.

• method(optional): string

  HTTP method for requesting the target of the link.

  Valid values are:

  • OPTIONS - HTTP OPTIONS
  • HEAD - HTTP HEAD
  • GET - HTTP GET
  • POST - HTTP POST
  • PUT - HTTP PUT
  • PATCH - HTTP PATCH
  • DELETE - HTTP DELETE

• profile(optional): string(uri)

  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.

• rel(optional): string

  Name of the link relation that, in addition to the type property, can be used to retrieve link details.

• templated(optional): boolean

  Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the property is not present.

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

Nested Schema : approvers

Type: object

List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not named approvers.

Introduced in release 19.3.3.

Show Source

• items: array items

  Collection of Request Approvers Member elements.

  Introduced in release 19.3.3.

{
    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-queryable":true,
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Match All

Show Source

• allOf CollectionResource

  All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

{
    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-queryable":true,
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : createdBy

Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : failure

Type: object

If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.

Nested Schema : job

Type: object

When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is blocked - blocked waiting for approval. A completed request will also have a job status that is completed.

Show Source

• completed: boolean

  Whether the asynchronous job is completed or not.

• completedPercentage(optional): integer(int32)

  A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.

• context(optional): string

  Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.

• endTime(optional): string(date-time)

  Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

• error(optional): object error

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

• intervalToPoll(optional): integer(int64)

  A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.

• links(optional): array links

  HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

• message(optional): string

  Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.

• progress: string

  The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: succeeded, failed, aborted. The value blocked means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: pending, processing, paused.

  Valid values are:

  • pending - Request is waiting to run
  • processing - Request is running
  • succeeded - Request has completed successfully
  • failed - Request has failed

  A processing request failed before it was completed.

  • aborted - Request was aborted

  A processing request was aborted before it was completed.

  • paused - Request was running, but is now paused
  • blocked - Request is blocked

  Request requires action, such as waiting for a human to approve something.

• requestStatus(optional): integer(int32)

  HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.

• result(optional): result

  It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.

• startTime(optional): string(date-time)

  Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

{
    "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "context":{
            "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "progress":{
            "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completed":{
            "description":"<p>Whether the asynchronous job is completed or not.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "requestStatus":{
            "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completedPercentage":{
            "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "intervalToPoll":{
            "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "error":{
            "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object"
        },
        "result":{
            "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/HttpResponse"
                }
            ]
        }
    },
    "required":[
        "progress",
        "completed"
    ]
}

Nested Schema : policy

Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.

Introduced in release 19.2.1.

Match All

Show Source

• allOf Policy

  A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.

  A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.

  A policy can be marked as inactive which prevents the operation from being performed or requested.

{
    "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
    "x-queryable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Policy"
        }
    ]
}

Nested Schema : reviews

Type: object

Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.

Show Source

• items: array items

  Collection of Review elements.

{
    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Review</em> elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Review"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Match All

Show Source

• allOf CollectionResource

  All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

{
    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Review</em> elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Review"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Collection of Request Approvers Member elements.

Introduced in release 19.3.3.

Show Source

• Array of: object items

{
    "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

Nested Schema : CollectionResource

All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object CollectionResource-allOf[1]

{
    "description":"<p>All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "totalResults":{
                    "description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "limit":{
                    "description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "count":{
                    "description":"<p>Total number of resources in the response.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "hasMore":{
                    "description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"boolean"
                },
                "offset":{
                    "description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

Nested Schema : CollectionResource-allOf[1]

Type: object

Show Source

• count(optional): integer(int32)

  Total number of resources in the response.

• hasMore(optional): boolean

  Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.

• limit(optional): integer(int32)

  Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.

• offset(optional): integer(int64)

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

• totalResults(optional): integer(int64)

  Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the totalResults parameter is supported and is set to true by the client.

{
    "properties":{
        "totalResults":{
            "description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "description":"<p>Total number of resources in the response.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"boolean"
        },
        "offset":{
            "description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string

  Display name for the user, client application or group.

  Introduced in release 19.3.3.
• group(optional): group

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

  Introduced in release 19.3.3.
• groupType(optional): string

  If the member is a group, then the type of group is specified. If the member is a user this field is not present.

  Valid values are:

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

  Introduced in release 20.1.1.
• id: string

  Identifier for the user, client application or group member.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 19.3.3.
• isExternalUser(optional): boolean

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

  Introduced in release 21.10.2.
• name: string

  Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

  Introduced in release 19.3.3.
• type: string

  Indicates the member is a user, client application or group.

  Valid values are:

  • user - Member is a user or a client application. No distinction is made between a member that is a user or a

  member that is a client application.

  • group - Member is a group

  Introduced in release 19.3.3.
• user(optional): user

  User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

  Introduced in release 19.3.3.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

Nested Schema : group

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

Introduced in release 19.3.3.

Match All

Show Source

• allOf Group

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

  Introduced in release 19.3.1.

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.3.

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : Group

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

Introduced in release 19.3.1.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Group-allOf[1]

{
    "description":"<p>A group is a collection of users and groups. A group has a human readable group name.</p><small>Introduced in release 19.3.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "type":{
                    "description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "groupName":{
                    "description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "displayName":{
                    "description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "roles":{
                    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : Group-allOf[1]

Type: object

Show Source

• displayName(optional): string

  Human-readable name for the group.

  Introduced in release 19.3.1.
• groupName(optional): string

  Group name that is unique within the service instance.

  Introduced in release 19.3.1.
• id(optional): string

  Unique identifer for the group.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 19.3.1.
• roles(optional): array roles

  Roles.

  Valid values are:

  • CECServiceAdministrator - Service Administrator

  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator

  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator

  • Create new content types and publish items
  • CECStandardUser - Standard User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User

  Reserved for future use.

  • CECIntegrationUser - Integration User

  Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

  • CECSitesVisitor - Sites Visitor

  Access sites restricted to visitors.

  Introduced in release 21.10.2.
• type(optional): string

  Type of the group.

  Valid values are:

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

  Introduced in release 19.3.1.

{
    "properties":{
        "id":{
            "description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupName":{
            "description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "roles":{
            "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : roles

Type: array

Roles.

Valid values are:

• CECServiceAdministrator - Service Administrator

• Assign user enumerates
• Change user passwords and challenge questions
• Configure, monitor, and manage service instances
• CECSitesAdministrator - Sites Administrator

• Create sites, templates, themes or components
• CECRepositoryAdministrator - Repository Administrator
• CECDeveloperUser - Developer User
• CECContentAdministrator - Content Administrator

• Create new content types and publish items
• CECStandardUser - Standard User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• View and interact with content items in sites
• Manage and view custom properties and edit values
• CECEnterpriseUser - Enterprise User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Digital Assets
• Content Items (editorial content management)
• Create, manage, view, and interact with content items
• Collections
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• Manage and view custom properties and edit values
• CECExternalUser - External User

Reserved for future use.

• CECIntegrationUser - Integration User

Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

• CECSitesVisitor - Sites Visitor

Access sites restricted to visitors.

Introduced in release 21.10.2.

Show Source

• Array of: string

{
    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Identity

Discriminator: type

Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

Introduced in release 20.3.1.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Identity-allOf[1]

{
    "description":"<p>Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.</p><small>Introduced in release 20.3.1.</small>",
    "discriminator":"type",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "type":{
                    "description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "id":{
                    "description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "displayName":{
                    "description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "roles":{
                    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : Identity-allOf[1]

Type: object

Show Source

• displayName(optional): string

  Human-readable display name.

  Introduced in release 20.3.1.
• id(optional): string

  An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 20.3.1.
• name(optional): string

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

  Introduced in release 20.3.1.
• roles(optional): array roles

  Roles.

  Valid values are:

  • CECServiceAdministrator - Service Administrator

  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator

  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator

  • Create new content types and publish items
  • CECStandardUser - Standard User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User

  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User

  Reserved for future use.

  • CECIntegrationUser - Integration User

  Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

  • CECSitesVisitor - Sites Visitor

  Access sites restricted to visitors.

  Introduced in release 21.10.2.
• type(optional): string

  Type of Identity. Valid values are: user, service, application, unknown.

  Introduced in release 20.3.1.

{
    "properties":{
        "type":{
            "description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "id":{
            "description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "roles":{
            "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : roles

Type: array

Roles.

Valid values are:

• CECServiceAdministrator - Service Administrator

• Assign user enumerates
• Change user passwords and challenge questions
• Configure, monitor, and manage service instances
• CECSitesAdministrator - Sites Administrator

• Create sites, templates, themes or components
• CECRepositoryAdministrator - Repository Administrator
• CECDeveloperUser - Developer User
• CECContentAdministrator - Content Administrator

• Create new content types and publish items
• CECStandardUser - Standard User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• View and interact with content items in sites
• Manage and view custom properties and edit values
• CECEnterpriseUser - Enterprise User

• Manage content (view, upload, and edit documents)
• Share content and sites with others
• Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
• Follow people
• Digital Assets
• Content Items (editorial content management)
• Create, manage, view, and interact with content items
• Collections
• Create, edit, and publish sites
• Manage and publish site themes
• Create, register, export, and import custom site components
• Create, edit, export, and import site templates
• Manage and view custom properties and edit values
• CECExternalUser - External User

Reserved for future use.

• CECIntegrationUser - Integration User

Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.

• CECSitesVisitor - Sites Visitor

Access sites restricted to visitors.

Introduced in release 21.10.2.

Show Source

• Array of: string

{
    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : error

Type: object

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

Nested Schema : links

Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : result

It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.

Match All

Show Source

• object HttpResponse

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

{
    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/HttpResponse"
        }
    ]
}

Nested Schema : items

Match All

Show Source

• object Link

  REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

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

• headers(optional): array headers

  HTTP response headers.

• status(optional): object status

  HTTP status code response value and reason.

{
    "description":"<p>Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.</p>",
    "properties":{
        "status":{
            "description":"<p>HTTP status code response value and reason.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "code":{
                    "description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "reason":{
                    "description":"<p>Short, human-readable summary of the status code.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            },
            "required":[
                "code",
                "reason"
            ]
        },
        "headers":{
            "description":"<p>HTTP response headers.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"<p>Header name.</p>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "value":{
                        "description":"<p>Header value.</p>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    }
                },
                "required":[
                    "name"
                ]
            }
        }
    }
}

Nested Schema : headers

Type: array

HTTP response headers.

Show Source

• Array of: object items

{
    "description":"<p>HTTP response headers.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"<p>Header name.</p>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "value":{
                "description":"<p>Header value.</p>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            }
        },
        "required":[
            "name"
        ]
    }
}

Nested Schema : status

Type: object

HTTP status code response value and reason.

Show Source

• code: integer(int32)

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

• reason: string

  Short, human-readable summary of the status code.

{
    "description":"<p>HTTP status code response value and reason.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "code":{
            "description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "reason":{
            "description":"<p>Short, human-readable summary of the status code.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Nested Schema : items

Type: object

Show Source

• name: string

  Header name.

• value(optional): string

  Header value.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"<p>Header name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "value":{
            "description":"<p>Header value.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : Policy

A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.

A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.

A policy can be marked as inactive which prevents the operation from being performed or requested.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Policy-allOf[1]

{
    "description":"<p>A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.</p><p>A policy is associated with a resource, for example a <em>site creation</em> policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.</p><p>A policy can be marked as <em>inactive</em> which prevents the operation from being performed or requested.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Globally unique identifier for a policy.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "minimal",
                        "basic"
                    ],
                    "type":"string"
                },
                "status":{
                    "description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "approvalType":{
                    "description":"<p>When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "approvers":{
                    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "accessType":{
                    "description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "access":{
                    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "security":{
                    "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SecurityPolicy"
                        }
                    ]
                },
                "repository":{
                    "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Repository"
                        }
                    ]
                },
                "localizationPolicyAllowed":{
                    "description":"<p>If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "sitePrefixAllowed":{
                    "description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "expiration":{
                    "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteExpirationPeriod"
                        }
                    ]
                },
                "revision":{
                    "description":"<p>Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

Nested Schema : Policy-allOf[1]

Type: object

Show Source

• access(optional): object access

  List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType of the policy is set to restricted.

  Introduced in release 19.3.1.
• accessType(optional): string

  Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.

  Valid values are:

  • everyone - Policy, when active, is applicable to everyone
  • restricted - Policy, when active, is applicable to users that are part of the access list

  Introduced in release 19.3.1.
• approvalType(optional): string

  When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.

  Valid values are:

  • automatic - A request will automatically be approved without any human approval process involved
  • admin - Any user with the site administrator role can approve the associated request
  • named - Site creation will require approval from one user that is a member of the approvers list associated with the policy

• approvers(optional): object approvers

  List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.

  Introduced in release 19.3.3.
• expiration(optional): expiration

  When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

  Introduced in release 19.4.1.
• id(optional): string

  Globally unique identifier for a policy.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• localizationPolicyAllowed(optional): boolean

  If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.

  Introduced in release 19.2.3.
• repository(optional): repository

  When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

  Introduced in release 19.2.3.
• revision(optional): integer(int64)

  Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong ETag value for this resource.

• security(optional): security

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

• sitePrefixAllowed(optional): boolean

  If true, a request for a new site can include an explicit site prefix. If false, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.

  Introduced in release 19.2.3.
• status(optional): string

  The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is inactive then the operation cannot be performed. If the policy status is active then the operation can be performed. For example, for a policy associated with a site template, a status of active means that users can create sites from that site template.

  Valid values are:

  • inactive - Policy that is marked as inactive means the associated operation cannot be requested
  • active - Policy that is marked as active means the associated operation can be requested

{
    "properties":{
        "id":{
            "description":"<p>Globally unique identifier for a policy.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "minimal",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "approvalType":{
            "description":"<p>When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "approvers":{
            "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "accessType":{
            "description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "access":{
            "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "security":{
            "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SecurityPolicy"
                }
            ]
        },
        "repository":{
            "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Repository"
                }
            ]
        },
        "localizationPolicyAllowed":{
            "description":"<p>If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "sitePrefixAllowed":{
            "description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "expiration":{
            "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteExpirationPeriod"
                }
            ]
        },
        "revision":{
            "description":"<p>Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : access

Type: object

List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType of the policy is set to restricted.

Introduced in release 19.3.1.

Show Source

• items: array items

  Collection of Policy Access Member elements.

  Introduced in release 19.3.1.

{
    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Match All

Show Source

• allOf CollectionResource

  All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

{
    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : approvers

Type: object

List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.

Introduced in release 19.3.3.

Show Source

• items: array items

  Collection of Policy Approvers Member elements.

  Introduced in release 19.3.3.

{
    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Match All

Show Source

• allOf CollectionResource

  All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

{
    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : expiration

When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

Introduced in release 19.4.1.

Match All

Show Source

• object SiteExpirationPeriod

  Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

  Introduced in release 19.4.1.

{
    "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteExpirationPeriod"
        }
    ]
}

Nested Schema : repository

When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

Introduced in release 19.2.3.

Match All

Show Source

• allOf Repository

  Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.

  A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.

{
    "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Repository"
        }
    ]
}

Nested Schema : security

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

Match All

Show Source

• object SecurityPolicy

  The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.

{
    "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SecurityPolicy"
        }
    ]
}

Nested Schema : items

Type: array

Collection of Policy Access Member elements.

Introduced in release 19.3.1.

Show Source

• Array of: object items

{
    "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string

  Display name for the user, client application or group.

  Introduced in release 19.3.1.
• group(optional): group

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

  Introduced in release 19.3.1.
• groupType(optional): string

  If the member is a group, then the type of group is specified. If the member is a user this field is not present.

  Valid values are:

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

  Introduced in release 20.1.1.
• id: string

  Identifier for the user, client application or group member.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 19.3.1.
• isExternalUser(optional): boolean

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

  Introduced in release 21.10.2.
• name: string

  Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

  Introduced in release 19.3.1.
• type: string

  Indicates the member is a user, client application or group.

  Valid values are:

  • user - Member is a user or a client application. No distinction is made between a member that is a user or a

  member that is a client application.

  • group - Member is a group

  Introduced in release 19.3.1.
• user(optional): user

  User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

  Introduced in release 19.3.1.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

Nested Schema : group

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

Introduced in release 19.3.1.

Match All

Show Source

• allOf Group

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

  Introduced in release 19.3.1.

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.1.

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : items

Type: array

Collection of Policy Approvers Member elements.

Introduced in release 19.3.3.

Show Source

• Array of: object items

{
    "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string

  Display name for the user, client application or group.

  Introduced in release 19.3.3.
• group(optional): group

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

  Introduced in release 19.3.3.
• groupType(optional): string

  If the member is a group, then the type of group is specified. If the member is a user this field is not present.

  Valid values are:

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

  Introduced in release 20.1.1.
• id: string

  Identifier for the user, client application or group member.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  Introduced in release 19.3.3.
• isExternalUser(optional): boolean

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

  Introduced in release 21.10.2.
• name: string

  Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

  Introduced in release 19.3.3.
• type: string

  Indicates the member is a user, client application or group.

  Valid values are:

  • user - Member is a user or a client application. No distinction is made between a member that is a user or a

  member that is a client application.

  • group - Member is a group

  Introduced in release 19.3.3.
• user(optional): user

  User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

  Introduced in release 19.3.3.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

Nested Schema : group

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

Introduced in release 19.3.3.

Match All

Show Source

• allOf Group

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

  Introduced in release 19.3.1.

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.3.

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Nested Schema : SiteExpirationPeriod

Type: object

Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

Introduced in release 19.4.1.

Show Source

• amount(optional): integer(int32)

  Amount of time used to measure site expiration.

  Introduced in release 19.4.1.
• unit(optional): string

  Unit of time used to measure site expiration.

  Valid values are:

  • months - Expiration expressed in the number of months
  • years - Expiration expressed in the number of years

  Introduced in release 19.4.1.

{
    "description":"<p>Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.</p><small>Introduced in release 19.4.1.</small>",
    "properties":{
        "amount":{
            "description":"<p>Amount of time used to measure site expiration.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "unit":{
            "description":"<p>Unit of time used to measure site expiration.</p><p>Valid values are:\n<ul><li> <code>months</code> - Expiration expressed in the number of months</li><li> <code>years</code> - Expiration expressed in the number of years</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : Repository

Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.

A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Repository-allOf[1]

{
    "description":"<p>Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.</p><p>A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "minimal",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Short human-readable name to identify the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "description":{
                    "description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "createdBy":{
                    "description":"<p>User that created the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "createdDate":{
                    "description":"<p>Date and time the repository was created.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "updatedBy":{
                    "description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "updatedDate":{
                    "description":"<p>Date and time the repository was last updated.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "autoTagEnabled":{
                    "description":"<p>Whether auto tagging is enabled for the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "contentTypes":{
                    "description":"<p>Content types associated with the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ContentTypeId"
                            }
                        ]
                    }
                },
                "channels":{
                    "description":"<p>Channels associated with the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ChannelId"
                            }
                        ]
                    }
                },
                "defaultLanguage":{
                    "description":"<p>Default language of the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "languageOptions":{
                    "description":"<p>Language options for the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "roleName":{
                    "description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : Repository-allOf[1]

Type: object

Show Source

• autoTagEnabled(optional): boolean

  Whether auto tagging is enabled for the repository.

• channels(optional): array channels

  Channels associated with the repository.

• contentTypes(optional): array contentTypes

  Content types associated with the repository.

• createdBy(optional): string

  User that created the repository.

• createdDate(optional): createdDate

  Date and time the repository was created.

• defaultLanguage(optional): string

  Default language of the repository.

• description(optional): string

  Human-readable description of the repository to give consumers an idea of what content this repository contains.

• id(optional): string

  Unique identifier for the repository.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• languageOptions(optional): array languageOptions

  Language options for the repository.

• name(optional): string

  Short human-readable name to identify the repository.

• roleName(optional): string

  The role the authenticated user has within the repository.

  Valid values are:

  • owner - Owner of the resource
  • custom - Custom role
  • manager - Manager role
  • contributor - Contributor role
  • downloader - Downloader role
  • viewer - Viewer role

• updatedBy(optional): string

  User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.

• updatedDate(optional): updatedDate

  Date and time the repository was last updated.

{
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "minimal",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short human-readable name to identify the repository.</p>",
            "x-returnedIn":[
                "representation",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "createdBy":{
            "description":"<p>User that created the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "createdDate":{
            "description":"<p>Date and time the repository was created.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "updatedBy":{
            "description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "updatedDate":{
            "description":"<p>Date and time the repository was last updated.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "autoTagEnabled":{
            "description":"<p>Whether auto tagging is enabled for the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "contentTypes":{
            "description":"<p>Content types associated with the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ContentTypeId"
                    }
                ]
            }
        },
        "channels":{
            "description":"<p>Channels associated with the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ChannelId"
                    }
                ]
            }
        },
        "defaultLanguage":{
            "description":"<p>Default language of the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "languageOptions":{
            "description":"<p>Language options for the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        }
    }
}

Nested Schema : channels

Type: array

Channels associated with the repository.

Show Source

• Array of: items

{
    "description":"<p>Channels associated with the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ChannelId"
            }
        ]
    }
}

Nested Schema : contentTypes

Type: array

Content types associated with the repository.

Show Source

• Array of: items

{
    "description":"<p>Content types associated with the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ContentTypeId"
            }
        ]
    }
}

Nested Schema : createdDate

Date and time the repository was created.

Match All

Show Source

• object DateTimeZone

  Date, time and time zone.

{
    "description":"<p>Date and time the repository was created.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

Nested Schema : languageOptions

Type: array

Language options for the repository.

Show Source

• Array of: string

{
    "description":"<p>Language options for the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : updatedDate

Date and time the repository was last updated.

Match All

Show Source

• object DateTimeZone

  Date, time and time zone.

{
    "description":"<p>Date and time the repository was last updated.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

Nested Schema : items

Match All

Show Source

• object ChannelId

  Channel identifier.

{
    "allOf":[
        {
            "$ref":"#/definitions/ChannelId"
        }
    ]
}

Nested Schema : ChannelId

Type: object

Channel identifier.

Show Source

• id(optional): string

  Unique identifier for the repository.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• name(optional): string

  Short unique human-readable name to identify the channel.

{
    "description":"<p>Channel identifier.</p>",
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short unique human-readable name to identify the channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : items

Match All

Show Source

• object ContentTypeId

  Content type identifier.

{
    "allOf":[
        {
            "$ref":"#/definitions/ContentTypeId"
        }
    ]
}

Nested Schema : ContentTypeId

Type: object

Content type identifier.

Show Source

• name(optional): string

  Content type name.

{
    "description":"<p>Content type identifier.</p>",
    "properties":{
        "name":{
            "description":"<p>Content type name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : DateTimeZone

Type: object

Date, time and time zone.

Show Source

• description(optional): string

  Description of the date, time and time zone information.

• timezone(optional): string

  Timezone in Olson database format.

• value(optional): string(date-time)

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

{
    "description":"<p>Date, time and time zone.</p>",
    "properties":{
        "value":{
            "description":"<p>Date in ISO 8601 format. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"<p>Timezone in Olson database format.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Description of the date, time and time zone information.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : SecurityPolicy

Type: object

The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.

Show Source

• appliesTo(optional): string

  Define which types of users may access a site. Can include all users or be restricted to named users only.

  Valid values are:

  • named - Only named users within a specified level can access
  • all - All users within a specified level can access

• level(optional): string

  Maximum open security level that can be set on a site.

  Valid values are:

  • service - Only service users
  • cloud - Only cloud users who can sign in to your domain
  • everyone - Anyone without signing in

{
    "description":"<p>The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.</p>",
    "properties":{
        "level":{
            "description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "appliesTo":{
            "description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Collection of Review elements.

Show Source

• Array of: items

{
    "description":"<p>Collection of <em>Review</em> elements.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Review"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• allOf Review

  A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.

{
    "allOf":[
        {
            "$ref":"#/definitions/Review"
        }
    ]
}

Nested Schema : Review

A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.

Match All

Show Source

• object SingularResource

  All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

• object Review-allOf[1]

{
    "description":"<p>A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, <em>auto approved</em> requests do not need a review. An <em>administrator approval</em> requires one administrator to review the request.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "decision":{
                    "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "comment":{
                    "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "createdAt":{
                    "description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "reviewedBy":{
                    "description":"<p>Get the details of the user or client application that created the review.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : Review-allOf[1]

Type: object

Show Source

• comment(optional): string
  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.

• createdAt(optional): string(date-time)

  Date and time that the review was created. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

• decision(optional): string

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

  Valid values are:

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

• id(optional): integer(int32)

  Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.

  No assumptions should be made about the content of the field; the field should be treated as an opaque value.

• reviewedBy(optional): reviewedBy

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

{
    "properties":{
        "id":{
            "description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "decision":{
            "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "comment":{
            "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "createdAt":{
            "description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "reviewedBy":{
            "description":"<p>Get the details of the user or client application that created the review.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        }
    }
}

Nested Schema : reviewedBy

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

Match All

Show Source

• allOf Identity
  Discriminator: type

  Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

  Introduced in release 20.3.1.

{
    "description":"<p>Get the details of the user or client application that created the review.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

Example Response (Invalid Request Status)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Request Status",
    "status":"409",
    "detail":"Operation cannot be performed on a request with status '{request.status}'.",
    "o:errorCode":"OCE-SITEMGMT-009009",
    "required":[
        "pending"
    ]
}

412 Response

Precondition Failed

413 Response

Payload Too Large

415 Response

Unsupported Media Type

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