1. REST API for Sites Management
  2. Tasks
  3. Requests
  4. Updating and Retries

Get an Example Request Body for Editing Request Resources

get

/sites/management/api/v1/requests/{id}/edit-form

EDIT FORM

Get a template request body suitable for editing request instances.The edit-form resource is used as a template for clients to determine which properties are updateable when editing a Request.The response will contain all the property values that can be edited. These properties can either be edited or discarded and then used as the request body to edit a Request.

Authorization

To access this edit-form resource requires read access to the parent resource.

Successful Response Examples

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

200OK

Request

GET https://api.example.com/sites/management/api/v1/requests/{id}/edit-form

Response Body

{
  "justification": "I require a marketing site for our new product.",
  "name": "MyNewProduct",
  "description": "This is a marketing site for my new product.",
  "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "localizationPolicy": "7D77CB6653BC1FF8E0530100007F6630",
  "defaultLanguage": "en-US",
  "sitePrefix": "News",
  "contentSecurity": {
    "taxonomy": "BC42C4FE109446539C9962DAC0C64CF2",
    "category": "AF11C4FE109446539C9962DAC0C09KF2"
  },
  "includeUpdates": false
}

Client Error Response Examples

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

404Not Found - 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 NameDescription
requestRequest 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"
  }
}

Request

Path Parameters

  • Globally unique immutable identifier for a request.

Query Parameters

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

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

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

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

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

    The following links are provided by this resource:

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

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Type: object
Show Source
  • contentSecurity

    The security category for the site.

    Targeted for a Future Release

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

  • The default language of the site. Must be one of the required languages of the localization policy. Required in requests for an enterprise site.

    Introduced in release 19.2.3.
  • Maximum Length: 1000

    The site description is used to help people understand the purpose and usage of the site. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.

  • Include unpublished updates in the copy.

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

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

  • The localization policy that will be associated with the site when it is created. Localization policies can be set only for enterprise sites. A localization policy cannot be associated with a request if the policy associated with the request specifies a localization policy.

    Introduced in release 19.2.3.
  • Maximum Length: 242

    This name is used during the site creation process and is used to identify the new site. Names must be unique; the name provided cannot be the same as the name of any existing site.

  • The asset repository that will be associated with the site when it is created. Repositories can be set only for enterprise sites. A repository cannot be associated with a request if the policy associated with the request specifies a repository.

    Introduced in release 19.2.3.
  • Maximum Length: 15

    The site prefix that will be set on a site when it is created. Will be set only on requests for an enterprise site. Can only be set only if the policy associated with the request allows; otherwise, the site prefix will be automatically generated. Site prefixes are limit to 15 characters in length.

    Introduced in release 19.2.3.
Nested Schema : contentSecurity

The security category for the site.

Targeted for a Future Release

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

Match All
Show Source
  • SiteContentSecurity

    Content security for a site.

    Targeted for a Future Release

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

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
Nested Schema : SiteContentSecurity
Type: object

Content security for a site.

Targeted for a Future Release

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

Show Source

  • Associated Taxonomy Category resource.

    Targeted for a Future Release

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

  • Associated Taxonomy resource.

    Targeted for a Future Release

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

Nested Schema : items
Match All
Show Source
  • Link
Example Response ()
{
    "justification":"I require a marketing site for our new product.",
    "name":"MyNewProduct",
    "description":"This is a marketing site for my new product.",
    "repository":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
    "localizationPolicy":"7D77CB6653BC1FF8E0530100007F6630",
    "defaultLanguage":"en-US",
    "sitePrefix":"News",
    "contentSecurity":{
        "taxonomy":"BC42C4FE109446539C9962DAC0C64CF2",
        "category":"AF11C4FE109446539C9962DAC0C09KF2"
    },
    "includeUpdates":false
}

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

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

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