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": "dolor aute",
"target-identifiers": "Lorem eu nulla",
"referrer-type": "labore Ut"
}
}
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": "command-template"
},
"totalReferencingInstances": 5592022.178730443,
"totalReferences": 4044642.840765223,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "esse aliquip et dolor",
"referencePaths": [
"Ut cillum",
"cupidatat labore nostrud ut",
"dolore culpa pariatur"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "transformation"
},
"totalReferencingInstances": -44491725.79539358,
"totalReferences": -33765924.36950991,
"references": {
"type": "form",
"_id": "5eb596edf955d0e5288f84ef",
"name": "nisi occaecat esse sed",
"referencePaths": [
"esse",
"irure Lorem cupidatat",
"dolor",
"et sint exercitation"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "template"
},
"totalReferencingInstances": -27304518.50020197,
"totalReferences": 82193965.17092651,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "Ut",
"referencePaths": [
"et ipsum sit culpa Ut"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "workflow"
},
"totalReferencingInstances": -10127250.851002231,
"totalReferences": 43934771.07103369,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "Excepteur veniam velit nostrud non",
"referencePaths": [
"aute consequat",
"sed ut cupidatat",
"incididunt dolor",
"velit aliquip eu aliqua in"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "command-template"
},
"totalReferencingInstances": 75900450.55208737,
"totalReferences": 4342049.459670112,
"references": {
"type": "command-template",
"_id": "5eb596edf955d0e5288f84ef",
"name": "occaecat adipisicing pariatur nostrud consectetur",
"referencePaths": [
"cupidatat elit sit Lorem",
"elit consectetur nostrud occaecat",
"in aliquip veniam id",
"incididunt"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}