Get blueprint

1 min

GET

/_cms/v1/blueprints/{key}

Get the blueprint with the provided key.

Path Parameters

keystringrequired
Description
The key of the blueprint to retrieve.

Header Parameters

If-None-Matchstring
Description
If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
If-Modified-Sincestring<http-date>
Description
If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
Format
http-date

Responses

200OK

Blueprint
Description
Represents a blueprint of a content item.
- keystring
  Description
  The unique identifier (key) of the resource.
- displayNamestringrequired
  Description
  The display name of this blueprint.
  Min Length
  1
  Max Length
  255
- contentTypestringrequired
  Description
  The content type of this blueprint.
  Min Length
  1
- createdstring<date-time>
  Description
  A timestamp indicating when this resource was first created.
  Format
  date-time
- createdBystring
  Description
  The name of the user or application that created this resource.
- lastModifiedstring<date-time>
  Description
  Indicates the last time this resource was modified.
  Format
  date-time
- lastModifiedBystring
  Description
  The name of the user or application that last modified this resource.
- contentBlueprintDatarequired
  Description
  Represents the data part of a Blueprint.
  - ContentData
    - bindingContentBinding
      Description
      Associates a content item with another source content item, establishing a relationship defined by a content type binding. Used for linking managed content to external or reference content.
      - contentTypeBindingstring
        Description
        The binding definition key that controls how the source content item is linked and accessed.
      - sourcestring<uri>required
        Description
        The reference to the source content item that is being bound. This cannot be empty.
        Format
        uri
    - propertiesmap<string, PropertyData>
      Description
      Properties as they are defined by corresponding component or content type.
  - object
    - compositionCompositionNode
      Description
      Specifies a node in a content composition.
      - idstring
        Description
        Specifies an identifier of this CompositionNode.
      - displayNamestring
        Description
        The display name of this ContentType.
        Max Length
        255
      - nodeTypestringrequired
        Description
        The node type of this CompositionNode.
        Min Length
        1
      - layoutTypestring
        Description
        The node layout type of this CompositionNode
      - displaySettingsCompositionDisplaySettings
        Description
        Defines display settings for a CompositionNode.
        displayTemplatestringrequired
        Description
        The display template that these settings apply to.
        Min Length
        1
        settingsmap<string, string>
        Description
        The display settings of this CompositionNode.
      - componentContentComponent
        Description
        Represents a content component.
        ContentData
        Circular-Reference
        object
        referencestring<uri>
        Description
        A reference to the content of this component. Cannot be assigned together with 'contentType' or 'properties'.
        Format
        uri
        contentTypestring
        Description
        The key of the content type that this is an embedded instance of.
      - nodesCompositionNode[]
        Description
        The child nodes for this CompositionNode.
        Circular-Reference

Response Headers

ETagstring
Description
The RFC7232 ETag header field in a response provides the current entity-tag for the resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time.
Last-Modifiedstring<http-date>
Description
The date and time at which the resource was last modified.
Format
http-date

304Not Modified

Response Headers

ETagstring
Description
The RFC7232 ETag header field in a response provides the current entity-tag for the resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time.
Last-Modifiedstring<http-date>
Description
The date and time at which the resource was last modified.
Format
http-date

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

curl

curl --request GET \
     --url /_cms/v1/blueprints/{key} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/_cms/v1/blueprints/{key}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/_cms/v1/blueprints/{key}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/_cms/v1/blueprints/{key}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "key": "",
  "displayName": "",
  "contentType": "",
  "created": "",
  "createdBy": "",
  "lastModified": "",
  "lastModifiedBy": "",
  "content": {}
}

304

// Not Modified

401

// Unauthorized

403

// Forbidden

404

// Not Found

500

// Internal Server Error