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": "voluptate",
"target-identifiers": "laborum exercitation eiusmod",
"referrer-type": "qui ex 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": "form"
},
"totalReferencingInstances": -18445896.77089213,
"totalReferences": 77876054.55529648,
"references": {
"type": "transformation",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "dolore veniam",
"referencePaths": [
"commodo ut cillum",
"anim nostrud sed",
"in",
"magna amet id"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "analytic-template"
},
"totalReferencingInstances": 16519279.506212786,
"totalReferences": 27097653.288483143,
"references": {
"type": "transformation",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "exercitation nostrud consequat",
"referencePaths": [
"dolor",
"nulla incididunt",
"ipsum in",
"ad in"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "form"
},
"totalReferencingInstances": -97027564.51596373,
"totalReferences": -13555774.970396727,
"references": {
"type": "json-form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "anim exercitation sint non",
"referencePaths": [
"est aliqua Excepteur anim ipsum",
"do dolor"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "analytic-template"
},
"totalReferencingInstances": 88602863.82629824,
"totalReferences": -4303756.393919274,
"references": {
"type": "workflow",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "exercitation nostrud culpa",
"referencePaths": [
"aute pariatur aliqua et",
"dolore velit"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}