List blueprints

1 min

GET

/_cms/v1/blueprints

List blueprints using the provided parameters.

Query Parameters

pageIndexinteger<int32>
Description
Zero based index of the page that should be retrieved.
Format
int32
Minimum
0
Maximum
10000
pageSizeinteger<int32>
Description
The maximum items per page that should be retrieved.
Format
int32
Minimum
1
Maximum
10000

Responses

200OK

BlueprintPage
Description
Represents a single page of items in a paged collection, including paging metadata such as the current page index, page size, and an estimated total item count.
- itemsBlueprint[]
  Description
  The items in this paged collection.
  - 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
        Max depth limit reached
        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
- pageIndexinteger<int32>
  Description
  The zero-based index of the current page.
  Format
  int32
- pageSizeinteger<int32>
  Description
  The number of items in each page. Not necessarily the same as the number of items in this page.
  Format
  int32
- totalCountinteger<int32>
  Description
  The estimated total number of items in the collection. May be omitted if the total count is unknown.
  Format
  int32

401Unauthorized

403Forbidden

500Internal Server Error

curl

curl --request GET \
     --url /_cms/v1/blueprints \
     --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", 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")

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"

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

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

print(response.text)

200

// OK
{
  "items": [
    {
      "key": "",
      "displayName": "",
      "contentType": "",
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": "",
      "content": {}
    }
  ],
  "pageIndex": "",
  "pageSize": "",
  "totalCount": ""
}

401

// Unauthorized

403

// Forbidden

500

// Internal Server Error