Summary
Gets references to a particular document.
Description
Gets references to a particular document.
Route
GET /automation-studio/references-to
Roles
admin
apiread
designer
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
queryParameters |
object |
yes |
Component group id. |
Copied to Clipboard
{
"queryParameters": {
"target-type": "qui veniam nulla dolor eiusmod",
"target-identifiers": "eiusmod officia et",
"referrer-type": "laborum adipisicing tempor elit sit"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryParameters": {
"title": "queryParameters",
"type": "object",
"description": "Options passed to the endpoint.",
"properties": {
"target-type": {
"type": "string",
"description": "Type of document to search for references to."
},
"target-identifiers": {
"type": "string",
"description": "IDs of the components to search for references to."
},
"referrer-type": {
"type": "string",
"description": "Type of documents to search for references in."
}
}
}
},
"required": [
"queryParameters"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Response object. |
Copied to Clipboard
{
"referencesByTarget": [
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "analytic-template"
},
"totalReferencingInstances": -92932731.40409818,
"totalReferences": 43640553.201707006,
"references": {
"type": "transformation",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "consectetur et officia",
"referencePaths": [
"magna qui mollit nulla",
"amet Lorem ex labore",
"in nostrud culpa",
"aliqua"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "workflow"
},
"totalReferencingInstances": 42527186.776183754,
"totalReferences": 65213498.50043771,
"references": {
"type": "json-form",
"_id": "5eb596edf955d0e5288f84ef",
"name": "velit commodo officia",
"referencePaths": [
"commodo Excepteur et do",
"dolore"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "analytic-template"
},
"totalReferencingInstances": -95847669.99005088,
"totalReferences": 34364941.067288965,
"references": {
"type": "workflow",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "sed in ullamco commodo",
"referencePaths": [
"minim deserunt commodo laborum adipisicing",
"aliqua in"
]
}
}
]
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"referencesByTarget": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target": {
"type": "object",
"properties": {
"identifer": {
"type": "string",
"examples": [
"940a1b4f-399a-44df-a42e-d37da51c7637",
"5eb596edf955d0e5288f84ef"
]
},
"type": {
"type": "string",
"enum": [
"workflow",
"json-form",
"transformation",
"template",
"command-template",
"analytic-template",
"form"
]
}
}
},
"totalReferencingInstances": {
"type": "number"
},
"totalReferences": {
"type": "number"
},
"references": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow",
"json-form",
"transformation",
"template",
"command-template",
"analytic-template",
"form"
]
},
"_id": {
"type": "string",
"examples": [
"940a1b4f-399a-44df-a42e-d37da51c7637",
"5eb596edf955d0e5288f84ef"
]
},
"name": {
"type": "string"
},
"referencePaths": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}