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": "ex",
"target-identifiers": "Excepteur consequat quis enim in",
"referrer-type": "nostrud"
}
}
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": -12893323.285820559,
"totalReferences": 34906709.84128931,
"references": {
"type": "analytic-template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "velit",
"referencePaths": [
"enim"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "json-form"
},
"totalReferencingInstances": -87319910.24394526,
"totalReferences": 1208002.102632299,
"references": {
"type": "template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "commodo irure sunt in magna",
"referencePaths": [
"sit fugiat",
"irure Excepteur sed esse cillum"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "analytic-template"
},
"totalReferencingInstances": 28007574.69696924,
"totalReferences": 81998871.97530821,
"references": {
"type": "analytic-template",
"_id": "5eb596edf955d0e5288f84ef",
"name": "minim esse irure",
"referencePaths": [
"incididunt Duis do",
"veniam reprehenderit tempor",
"et dolore pariatur consequat proident",
"eiusmod esse deserunt",
"do cillum sunt dolore esse"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "analytic-template"
},
"totalReferencingInstances": -64962867.80601701,
"totalReferences": -32194306.79086028,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "ipsum laborum minim sit exercitation",
"referencePaths": [
"ullamco est",
"fugiat nisi aute qui consectetur",
"cillum",
"irure in"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "workflow"
},
"totalReferencingInstances": 84803383.71981436,
"totalReferences": -19158283.2037275,
"references": {
"type": "json-form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "voluptate",
"referencePaths": [
"Ut consectetur",
"esse consectetur cupidatat aute",
"dolore amet enim Duis proident"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}