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": "enim",
"target-identifiers": "Excepteur qui minim irure voluptate",
"referrer-type": "velit consequat aliquip proident"
}
}
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": "5eb596edf955d0e5288f84ef",
"type": "transformation"
},
"totalReferencingInstances": -68447910.04644454,
"totalReferences": 87242520.80989605,
"references": {
"type": "workflow",
"_id": "5eb596edf955d0e5288f84ef",
"name": "aliquip eiusmod proident irure in",
"referencePaths": [
"Lorem",
"mollit quis",
"irure consectetur magna",
"eiusmod dolore in sit quis"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "analytic-template"
},
"totalReferencingInstances": -40717840.67392525,
"totalReferences": -91938077.20886546,
"references": {
"type": "template",
"_id": "5eb596edf955d0e5288f84ef",
"name": "culpa Lorem",
"referencePaths": [
"laborum et anim",
"aliqua nisi cillum incididunt",
"officia amet",
"ex proident"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "workflow"
},
"totalReferencingInstances": 75343608.08426529,
"totalReferences": 60706523.932403624,
"references": {
"type": "transformation",
"_id": "5eb596edf955d0e5288f84ef",
"name": "laboris elit cupidatat ut",
"referencePaths": [
"commodo nisi proident",
"labore sint in amet",
"et qui esse adipisicing sed"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "workflow"
},
"totalReferencingInstances": 13472437.080700532,
"totalReferences": -21776606.199110523,
"references": {
"type": "template",
"_id": "5eb596edf955d0e5288f84ef",
"name": "incididunt cupidatat dolore proident",
"referencePaths": [
"Duis incididunt cupidatat",
"eu in consectetur"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "transformation"
},
"totalReferencingInstances": 17302929.470242262,
"totalReferences": 96047358.96602756,
"references": {
"type": "analytic-template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "sunt elit eiusmod dolore fugiat",
"referencePaths": [
"commodo",
"tempor ad",
"sint veniam sit",
"dolor elit sed esse"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}