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 officia",
"target-identifiers": "consectetur sed ullamco et",
"referrer-type": "Lorem consectetur minim"
}
}
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": "workflow"
},
"totalReferencingInstances": -30793077.33849244,
"totalReferences": 6848411.9244083315,
"references": {
"type": "template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "dolor laboris",
"referencePaths": [
"laborum",
"dolor ut voluptate irure ullamco",
"Ut elit laboris qui in"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "analytic-template"
},
"totalReferencingInstances": 46302564.20988181,
"totalReferences": 73695529.51217714,
"references": {
"type": "analytic-template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "labore",
"referencePaths": [
"officia Ut amet cillum",
"dolor",
"et in velit esse do",
"laborum enim et"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "transformation"
},
"totalReferencingInstances": 36900100.583340436,
"totalReferences": -69361918.96696648,
"references": {
"type": "template",
"_id": "5eb596edf955d0e5288f84ef",
"name": "tempor qui pariatur ea ad",
"referencePaths": [
"dolore ut",
"Ut",
"officia velit et"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "analytic-template"
},
"totalReferencingInstances": 8441233.810617104,
"totalReferences": 61004925.59416467,
"references": {
"type": "workflow",
"_id": "5eb596edf955d0e5288f84ef",
"name": "ex ipsum veniam culpa",
"referencePaths": [
"eu ut culpa dolor aliquip"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "workflow"
},
"totalReferencingInstances": 69726331.04728344,
"totalReferences": 88544868.37687224,
"references": {
"type": "json-form",
"_id": "5eb596edf955d0e5288f84ef",
"name": "do veniam",
"referencePaths": [
"incididunt",
"anim sunt pariatur minim",
"in Ut cupidatat"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}