Calculate Dependencies
Calculate and return dependencies for one or more items.
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
|
POST
|
URL
|
/api/1/services/api/1/dependency/calculate-dependencies.json`
|
Response Formats
|
JSON |
Required Role
|
Site member
|
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
site_id
|
String
|
✓
|
Site to use
|
item
|
String
|
✓
|
Path to the item(s)
|
Example
POST .../api/1/services/api/1/dependency/calculate-dependencies.json?site_id=mysite
1{
2 "entities" : [
3 {
4 "item" : "/path/to/item1.xml",
5 },
6 {
7 "item" : "/path/to/item2.xml",
8 }
9 ]
10}
Response
1{
2 "result" : {
3 "entities" : [
4 {
5 "item" : "/path/to/item1.xml",
6 "dependencies" : [
7 {
8 "item" : "/path/to/dep1.xml"
9 },
10 {
11 "item" : "/path/to/dep2.xml"
12 }
13 ]
14 },
15 {
16 "item" : "/path/to/item2.xml",
17 "dependencies" : [
18 {
19 "item" : "/path/to/dep1.xml"
20 },
21 {
22 "item" : "/path/to/dep2.xml"
23 }
24 ]
25 },
26 ]
27 }
28}
Responses
Status
|
Response Body
|
|---|---|
200
|
{ "message" : "OK" } |
400
|
{ "message" : "Invalid parameter(s)" } |
400
|
{ "message" : "Bad Request" } |
401
|
{ "message" : "Unauthorized" } |
404
|
{ "message" : "Site not found" } |
500
|
{ "message" : "Internal server error.ACTUAL_EXCEPTION" } |