• Document Up to Date

Get Descriptor

Get the descriptor data of an Item in the content store.

Resource Information

This service uses the tomcat application on port 8080 by default. To see a list of default ports click here

The context for this API is /.

HTTP Verb
GET
URL
/api/1/content_store/descriptor
Response Formats
JSON, XML

Parameters

Name
Type
Required
Description
contextId
String
✓
The context id
url
String
✓
The folder’s url (e.g. /site/website)
flatten
Boolean


Indicates if included descriptors
should be flattened

Example

Request

GET .../api/1/content_store/descriptor.json?contextId=405ffc233d075b010536bd2eb786b86c&url=/site/website/index.xml

Response

Status 200 OK

 1{
 2  "page": {
 3    "content-type": "/page/home",
 4    "display-template": "/templates/web/pages/home.ftl",
 5    "merge-strategy": "inherit-levels",
 6    "placeInNav": "false",
 7    "file-name": "index.xml",
 8    "objectGroupId": "8d7f",
 9    "objectId": "8d7f21fa-5e09-00aa-8340-853b7db302da",
10    "folder-name": null,
11    "header": {
12      "item": {
13        "key": "/site/components/headers/header.xml",
14        "value": "Header",
15        "include": "/site/components/headers/header.xml",
16        "disableFlattening": "false"
17      }
18    },
19    "createdDate": "1/31/2017 16:18:14",
20    "createdDate_dt": "1/31/2017 16:18:14",
21    "lastModifiedDate": "5/18/2017 15:52:21",
22    "lastModifiedDate_dt": "5/18/2017 15:52:21",
23    "left-rail": {
24      "item": {
25        "key": "/site/components/left-rails/left-rail-with-latest-articles.xml",
26        "value": "Left Rail with Latest Articles",
27        "include": "/site/components/left-rails/left-rail-with-latest-articles.xml",
28        "disableFlattening": "false"
29      }
30    },
31    "internal-name": "Home",
32    "orderDefault_f": "-1",
33    "title": "Editorial",
34    "hero_text": "<p>Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam.</p>",
35    "hero_title": "<h1><span>Hi, I&rsquo;m Editorial</span></h1>\n<h3><span style=\"font-size: 1.5em;\">by HTML5 UP</span></h3>",
36    "features": {
37      "item": [
38        {
39          "value": "Quam lorem ipsum",
40          "key": "/site/components/features/quam-lorem-ipsum.xml",
41          "include": "/site/components/features/quam-lorem-ipsum.xml",
42          "disableFlattening": "false"
43        },
44        {
45          "key": "/site/components/features/sapien-veroeros.xml",
46          "value": "Sapien Veroeros",
47          "include": "/site/components/features/sapien-veroeros.xml",
48          "disableFlattening": "false"
49        }
50      ]
51    },
52    "hero_image": "/static-assets/images/strawberries.jpg",
53    "features_title": "Erat lacinia"
54  }
55}

Responses

Status
Location
Response Body
200

See example above.
404

"No item found at /site/website/index.xml"
500

"Internal server error"