1. REST API for Sites Management
  2. Tasks
  3. Sites
  4. Creating, Updating and Copying

Get an Example Request Body for Creating Site Resources

get

/sites/management/api/v1/sites/create-form

CREATE FORM

Get a template request body suitable for creating a new site.The create-form resource provides an example request body that clients can use as a template when creating a new Site. The example request body property values can be edited, removed or added to and then used as the request body when creating a Site. Use of the create form is optional, it is only provided as a guide to the request body format.

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/sites/create-form

Response Body

{
  "requestType": "SiteRequest",
  "justification": "I require a marketing site for our new product.",
  "template": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6",
  "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0",
  "name": "MyNewProduct",
  "description": "This is a marketing site for my new product.",
  "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "localizationPolicy": "7D77CB6653BC1FF8E0530100007F6630",
  "defaultLanguage": "en-US",
  "sitePrefix": "News",
  "ownedBy": "1234",
  "contentSecurity": {
    "taxonomy": "BC42C4FE109446539C9962DAC0C64CF2",
    "category": "AF11C4FE109446539C9962DAC0C09KF2"
  }
}

Client Error Response Examples

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

400Bad Request - Deleted Filter Required

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

Error Code

OCE-DOCS-001007

Resolution - Listing Resources in Trash

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

Resolution - Listing Resources Not in Trash

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

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

Introduced in release 19.4.3.

Request

Query Parameters

  • Comma-delimited string of field names that 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.

  • 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.
    createDescribes where the resource can be created. Used on collection resources to indicate where a post can be performed to create a new resource in the collection.
    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.

  • Optionally provided identifier for the site. This id must be unique within the service. If not provided an identifier will be allocated automatically.

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

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

  • Get the user or client application that will own the site. The user or client application that owns the site may be different than the user or client application that created the request if the request was created on behalf of another user.

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

  • Get the template associated with the request. When a request for a new site is created, the template from which the site should be created is specified and then associated with the request. If the request is not a new site request a template will not be returned.

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 ()
{
    "requestType":"SiteRequest",
    "justification":"I require a marketing site for our new product.",
    "template":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6",
    "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0",
    "name":"MyNewProduct",
    "description":"This is a marketing site for my new product.",
    "repository":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
    "localizationPolicy":"7D77CB6653BC1FF8E0530100007F6630",
    "defaultLanguage":"en-US",
    "sitePrefix":"News",
    "ownedBy":"1234",
    "contentSecurity":{
        "taxonomy":"BC42C4FE109446539C9962DAC0C64CF2",
        "category":"AF11C4FE109446539C9962DAC0C09KF2"
    }
}

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : DeletedRequiredExceptionDetail
Introduced in release 19.4.3.
Match All
Show Source
  • ExceptionDetail

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

Nested Schema : ExceptionDetail
Type: object

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

Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

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

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

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

401 Response

Unauthorized

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top