REST API for Sites Management

Get an Example Request Body for Creating Template Resources

get

/sites/management/api/v1/sites/{id}/templates/create-form

CREATE FORM

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

Introduced in release 19.4.1.

Authorization

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

For more information, see Get Site Details

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

Introduced in release 19.4.1.

Successful Response Examples

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

200OK

Request

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

Response Body

{
  "name": "CafeSupremo",
  "description": "A description of something.",
  "includeUnpublished": false,
  "type": "inherit"
}

Request

Path Parameters

id: string

Immutable identifier for the site.

Query Parameters

excludeFields(optional): string

Comma-delimited string of field names that should not be included in the response.
excludeLinks(optional): string

Comma-separated list of link relation names to exclude from the response.
fields(optional): string

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.
includeDeleted(optional): boolean

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.

links(optional): string

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 Relationship	Description
`self`	Describes 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.
`canonical`	Describes 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.
`create`	Describes 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.
`describedBy`	Describes 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.

Response

Supported Media Types

application/json
application/vnd.oracle.resource+json;type=create-form

200 Response

Headers

Cache-Control: string

Directives for caching mechanisms.
Content-Length: string

Size of the response body.
Content-Type: string

Content type of the response.

Root Schema : schema

Type: object

Show Source

description(optional): string

Maximum Length: 1000

Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.
Introduced in release 19.4.1.
includeUnpublished(optional): boolean

Include unpublished content items and digital assets in your template. If set to true then both published and unpublished content items and digital assets are included in the template. If set to false then only published content items and digital assets are included in the template. If not specified the default is to include only published content items and digital assets.
Introduced in release 19.4.1.
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.
name: string

Maximum Length: 242

Name of the template.
Introduced in release 19.4.1.
type(optional): string
Type of template to create. If set to enterprise then the created template will be an enterprise template even if the site is not an enterprise site. If set to inherit then the template type will inherit the type from the site. If not specified the default is for the template inherit the type from the site.
Valid values are:
- inherit - Template type will be inherited from the site
- enterprise - Create an enterprise template
Introduced in release 21.1.2.

{
    "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"
                    }
                ]
            }
        },
        "name":{
            "description":"<p>Name of the template. </p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":242
        },
        "description":{
            "description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "includeUnpublished":{
            "description":"<p>Include unpublished content items and digital assets in your template. If set to <code>true</code> then both published and unpublished content items and digital assets are included in the template. If set to <code>false</code> then only published content items and digital assets are included in the template. If not specified the default is to include only published content items and digital assets.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "type":{
            "description":"<p>Type of template to create. If set to <code>enterprise</code> then the created template will be an enterprise template even if the site is not an enterprise site. If set to <code>inherit</code> then the template type will inherit the type from the site. If not specified the default is for the template inherit the type from the site.</p><p>Valid values are:\n<ul><li> <code>inherit</code> - Template type will be inherited from the site</li><li> <code>enterprise</code> - Create an enterprise template</li></p><small>Introduced in release 21.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "name"
    ]
}

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"
        }
    }
}

Example Response ()

{
    "name":"CafeSupremo",
    "description":"A description of something.",
    "includeUnpublished":false,
    "type":"inherit"
}

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

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