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": "magna",
"target-identifiers": "officia eiusmod",
"referrer-type": "qui fugiat proident eiusmod dolor"
}
}
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": 44136033.34968847,
"totalReferences": 51956062.16443807,
"references": {
"type": "json-form",
"_id": "5eb596edf955d0e5288f84ef",
"name": "sint",
"referencePaths": [
"Duis ut"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "json-form"
},
"totalReferencingInstances": 32946392.209158853,
"totalReferences": 24507461.844955042,
"references": {
"type": "template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "commodo exercitation velit",
"referencePaths": [
"velit in in reprehenderit nulla",
"ullamco consectetur",
"tempor",
"cillum in",
"est cillum sunt eiusmod minim"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "command-template"
},
"totalReferencingInstances": -35110845.50256931,
"totalReferences": 4232823.009339586,
"references": {
"type": "transformation",
"_id": "5eb596edf955d0e5288f84ef",
"name": "irure",
"referencePaths": [
"ad",
"aliquip voluptate consectetur id",
"ex",
"sint pariatur in esse dolore",
"irure quis dolore"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "template"
},
"totalReferencingInstances": 72730773.64981285,
"totalReferences": -16841369.140060574,
"references": {
"type": "transformation",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "consectetur do",
"referencePaths": [
"minim anim dolor",
"fugiat",
"anim"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "workflow"
},
"totalReferencingInstances": 58142877.1876992,
"totalReferences": -66991043.93726549,
"references": {
"type": "command-template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "eu et cupidatat sit dolore",
"referencePaths": [
"Ut eu aute",
"ea esse elit mollit",
"proident in non veniam nisi",
"eiusmod proident occaecat in",
"voluptate ut 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"
}
}
}
}
}
}
}
}
}