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": "est consequat esse cillum in",
"target-identifiers": "ut occaecat mollit",
"referrer-type": "cupidatat"
}
}
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": "workflow"
},
"totalReferencingInstances": 83032169.7364758,
"totalReferences": 88425513.98588654,
"references": {
"type": "analytic-template",
"_id": "5eb596edf955d0e5288f84ef",
"name": "id consectetur cillum",
"referencePaths": [
"qui culpa eu"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "analytic-template"
},
"totalReferencingInstances": -1367121.8849443048,
"totalReferences": -14845400.875681937,
"references": {
"type": "workflow",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "Excepteur nulla",
"referencePaths": [
"voluptate minim amet dolor cupidatat",
"ullamco",
"eu culpa deserunt",
"in Duis anim do aliqua"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "json-form"
},
"totalReferencingInstances": -17123196.58873555,
"totalReferences": -91239332.14812632,
"references": {
"type": "workflow",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "reprehenderit ut dolore",
"referencePaths": [
"ex voluptate",
"labore enim sint est",
"qui"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "json-form"
},
"totalReferencingInstances": -6201286.0923009515,
"totalReferences": -26033972.103158474,
"references": {
"type": "template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "Duis",
"referencePaths": [
"ipsum laborum labore",
"dolore consequat adipisicing",
"nisi",
"dolore nisi tempor in Ut"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}