Extend the Expiration Period for a Site

post

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

EXTENDED OPERATION

Extend the expiration date of a site. If a site has expired the site cannot be activated; extending the expiration date will allow a site manager to bring the site online. The expiration date can also be extended for a site that has not expired, for example, when the site is nearing the expiration date.

Introduced in release 19.4.1.

Authorization

Site administrators can extend the expiration date of any site regardless of whether the site has been shared with the site administrator. Any user that has one of the following sharing roles can also extend the expiration date:

  • Owner
  • Manager

Expiration Date Calculation

The site expiration date will be extended using the site expiration policy associated with the site. The expiration date is extended relative to the current date and set to 23:59:00 on the last day of expiration, using an UTC time zone.

No Expiration Period or Inactive Policy

If the extend policy associated with the site does not have an expiration period set or the policy is set as inactive then the extend operation will fail with an inactive policy error and the site expiration date will not have change.

Setting an Explicit Site Expiration Date

If an explicit expiration date is required, or a site does not have an expiration date and an expiration date is required, then the site expiration date can be explicitly updated by a site administrator.

For more information, see Update the Fields of a Site.

Path Alternative Identifiers

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

nameSite Name

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

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

Introduced in release 19.4.1.

Redirection Response Examples

This operation responds with the following redirection (3xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation. Note: Depending on the client technology used to invoke this operation a 2xx response may be returned if the redirection is followed automatically.

303See Other - Extend the Site Expiration Date

Extend the expiration date of the site by the period defined by the associated policy.

Request

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

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.

403Forbidden - Inactive Policy

Indicates that an operation is not allowed as the policy for the operation is inactive.

Error Code

OCE-SITEMGMT-009071

Resolution - Check Policy is Active

Get a site administrator to check that the policy associated with operation is marked as active.

Exception Detail Fields

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

Field NameDescription
policyPolicy that is governing this operation.

For detailed information about this exception detail type, consult the InactivePolicyExceptionDetail 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": "Inactive Policy",
  "status": "403",
  "detail": "The policy for this operation is inactive.",
  "o:errorCode": "OCE-SITEMGMT-009071",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  }
}

403Forbidden - Restricted Policy

Indicates that an operation is not allowed as the policy for the operation is restricted.

Error Code

OCE-SITEMGMT-009072

Resolution - Add User to the Access List

Get a site administrator to add the user or client application as a member of the policy access list.

Resolution - Change the Policy to Everyone Access

Get a site administrator to change the policy accessType to everyone.

Exception Detail Fields

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

Field NameDescription
policyPolicy that is governing this operation.
userUser or application that is not a member of the policy access list.

For detailed information about this exception detail type, consult the RestrictedPolicyExceptionDetail 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": "Restricted Policy",
  "status": "403",
  "detail": "The policy for the operation has a restricted audience and can't be used by the user or client application.",
  "o:errorCode": "OCE-SITEMGMT-009072",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  },
  "user": {
    "id": "1234"
  }
}

404Not Found - Site Not Found

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

Error Code

OCE-SITEMGMT-009003

Resolution - Check Identifier

Check that the site identifier is valid.

Resolution - Check Membership

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

Exception Detail Fields

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

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

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

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

409Conflict - Site Deleted

The operation cannot be performed on a soft deleted site. This error can only occur when the includeDeleted query parameter is set to true.

Error Code

OCE-SITEMGMT-009059

Resolution - Restore Site

Restore the site and then try the operation again.

Exception Detail Fields

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

Field NameDescription
siteSite that is soft deleted, if the site identifier has been provided.

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

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Deleted",
  "status": "409",
  "detail": "The operation cannot be performed as the site has been soft deleted.",
  "o:errorCode": "OCE-SITEMGMT-009059",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

Introduced in release 19.4.1.

Request

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

Back to Top

Response

303 Response

See Other
Headers

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : InactivePolicyExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

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

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

Multiple errors can be organized in a hierarchical structure.

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

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

Example Response (Inactive Policy)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Inactive Policy",
    "status":"403",
    "detail":"The policy for this operation is inactive.",
    "o:errorCode":"OCE-SITEMGMT-009071",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    }
}
Example Response (Restricted Policy)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Restricted Policy",
    "status":"403",
    "detail":"The policy for the operation has a restricted audience and can't be used by the user or client application.",
    "o:errorCode":"OCE-SITEMGMT-009072",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    },
    "user":{
        "id":"1234"
    }
}

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteNotFoundExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

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

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

Multiple errors can be organized in a hierarchical structure.

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

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

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

409 Response

Conflict
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteDeletedExceptionDetail
Introduced in release 19.4.1.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

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

Show Source
Nested Schema : SiteDeletedExceptionDetail-allOf[1]
Type: object
Show Source
  • Site that is soft deleted, if the site identifier has been provided.

    Introduced in release 19.4.1.
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

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

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

Example Response (Site Deleted)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the site has been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009059",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

413 Response

Payload Too Large

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top