Get Content Item
Get content item.
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 /studio, please prefix the API URLs with this context.
HTTP Verb
|
GET
|
URL
|
/api/1/services/api/1/content/get-item.json |
Response Formats
|
JSON |
Required Role
|
N/A
|
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
site_id
|
String
|
✓
|
Site to use
|
path
|
String
|
✓
|
Path of the content
|
Example
Request
GET .../api/1/services/api/1/content/get-item.json?site_id=mysite&path=/site/website/index.xml&edit=true
Response
Status 200 OK
1{
2 "item":
3 {
4 "name":"index.xml",
5 "internalName":"Home",
6 "contentType":"/page/home",
7 "uri":"/site/website/index.xml",
8 "path":"/site/website",
9 "browserUri":"",
10 "navigation":false,
11 "floating":true,
12 "hideInAuthoring":false,
13 "previewable":true,
14 "lockOwner":"",
15 "user":"admin",
16 "userFirstName":"admin",
17 "userLastName":"",
18 "nodeRef":null,
19 "metaDescription":null,
20 "site":"documentation",
21 "page":true,
22 "component":false,
23 "document":false,
24 "asset":false,
25 "isContainer":false,
26 "container":false,
27 "disabled":false,
28 "savedAsDraft":false,
29 "submitted":false,
30 "submittedForDeletion":false,
31 "scheduled":false,
32 "published":false,
33 "deleted":false,
34 "inProgress":true,
35 "live":false,
36 "inFlight":false,
37 "isDisabled":false,
38 "isSavedAsDraft":false,
39 "isInProgress":true,
40 "isLive":false,
41 "isSubmittedForDeletion":false,
42 "isScheduled":false,
43 "isPublished":false,
44 "isNavigation":false,
45 "isDeleted":false,
46 "isNew":false,
47 "isSubmitted":false,
48 "isFloating":false,
49 "isPage":true,
50 "isPreviewable":true,
51 "isComponent":false,
52 "isDocument":false,
53 "isAsset":false,
54 "isInFlight":false,
55 "eventDate":"2017-07-05T21:32:02+02:00",
56 "endpoint":null,
57 "timezone":null,
58 "numOfChildren":0,
59 "scheduledDate":null,
60 "publishedDate":null,
61 "mandatoryParent":null,
62 "isLevelDescriptor":false,
63 "categoryRoot":null,
64 "lastEditDate":"2017-07-05T21:32:02+02:00",
65 "form":"/page/home",
66 "formPagePath":"simple",
67 "renderingTemplates":
68 [
69 {
70 "uri":"/templates/web/pages/home.ftl","name":"DEFAULT"
71 }
72 ],
73 "folder":false,
74 "submissionComment":null,
75 "components":null,
76 "documents":null,
77 "levelDescriptors":null,
78 "pages":null,
79 "parentPath":null,
80 "orders":
81 [
82 {
83 "name":null,
84 "id":"default",
85 "disabled":null,
86 "order":-1.0,
87 "placeInNav":null
88 }
89 ],
90 "children":[ ],
91 "size":0.0,
92 "sizeUnit":null,
93 "mimeType":"application/xml",
94 "levelDescriptor":false,
95 "newFile":false,
96 "reference":false,
97 "new":false
98 }
99}
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
See example above.
|
|
403
|
“Access denied”
|