Get version

1 min

GET

/_cms/v1/content/{key}/versions/{version}

Get the content item with the provided key and version.

Path Parameters

keystringrequired
versionstringrequired

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

ContentVersion
Description
Represents a version of a content item.
- objectContentData
  - 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
  - keystring
    Description
    The key that identifies this content version.
  - localestring
    Description
    The locale of this content version.
  - versionstring
    Description
    The version identifier of this instance.
  - variationstring
    Description
    The variation of this content version, if any. Variations are used to represent different states or forms of the same content item. A variation has its own publishing lifecycle. A variation cannot be published before the default version of same locale has been published.
  - contentTypestring
    Description
    The content type of this content item.
  - displayNamestringrequired
    Description
    The display name of this content version.
    Min Length
    1
    Max Length
    255
  - publishedstring<date-time>
    Description
    Indicates a time when this content was published or should be published.
    Format
    date-time
  - expiredstring<date-time>
    Description
    Indicates a time when this content expired or should expire.
    Format
    date-time
  - statusstring<draft | ready | published | previous | scheduled | rejected | inReview>
    Description
    The status of this content version.
    Allowed
    draftreadypublishedpreviousscheduledrejectedinReview
  - delayPublishUntilstring<date-time>
    Description
    The timestamp when a scheduled version will be published. Only present when status is 'scheduled'.
    Format
    date-time
  - routeSegmentstring
    Description
    A string that represents the segment that should be used when routing or generating routes to the current content instance. This value will always be null when content is based on a non-routable content type.
    Max Length
    255
  - simpleRoutestring
    Description
    A simple route (shortcut URL) used to access pages and experiences.
    Max Length
    253
    Pattern
    ^[^/].*$
  - lastModifiedstring<date-time>
    Format
    date-time
  - lastModifiedBystring
  - 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
        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
        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
  - mediaMediaData
    Description
    Represents media data attached to a content item.
    - keystring
      Description
      The key referencing the media.
      Pattern
      ^[a-f0-9]{32}\.[a-zA-Z0-9]{1,20}$

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/content/{key}/versions/{version} \
     --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/content/{key}/versions/{version}", 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/content/{key}/versions/{version}")

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/content/{key}/versions/{version}"

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

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

print(response.text)

200

// OK
{
  "binding": {
    "contentTypeBinding": "",
    "source": ""
  },
  "properties": "",
  "key": "",
  "locale": "",
  "version": "",
  "variation": "",
  "contentType": "",
  "displayName": "",
  "published": "",
  "expired": "",
  "status": "",
  "delayPublishUntil": "",
  "routeSegment": "",
  "simpleRoute": "",
  "lastModified": "",
  "lastModifiedBy": "",
  "composition": {
    "id": "",
    "displayName": "",
    "nodeType": "",
    "layoutType": "",
    "displaySettings": {
      "displayTemplate": "",
      "settings": ""
    },
    "component": {},
    "nodes": [
      {
        "": ""
      }
    ]
  },
  "media": {
    "key": ""
  }
}

304

// Not Modified

401

// Unauthorized

403

// Forbidden

404

// Not Found

500

// Internal Server Error