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": "aliquip exercitation",
"target-identifiers": "aliquip",
"referrer-type": "Duis adipisicing proident deserunt reprehenderit"
}
}
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": "json-form"
},
"totalReferencingInstances": 24999017.837989345,
"totalReferences": 95795580.86528891,
"references": {
"type": "json-form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "officia labore",
"referencePaths": [
"eiusmod esse dolore non dolor",
"nulla elit voluptate ea",
"eu dolor",
"dolor laboris sit Duis nulla",
"quis dolore"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "workflow"
},
"totalReferencingInstances": 38584239.710137546,
"totalReferences": -24355632.61737843,
"references": {
"type": "analytic-template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "sit enim occaecat incididunt dolor",
"referencePaths": [
"ex incididunt sed tempor ut",
"pariatur id in in mollit"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "json-form"
},
"totalReferencingInstances": 18740331.46923977,
"totalReferences": -47665169.94888344,
"references": {
"type": "template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "velit Ut labore",
"referencePaths": [
"Duis Ut fugiat reprehenderit occaecat",
"sunt Ut sit deserunt",
"dolor exercitation mollit et",
"et",
"consequat qui nisi enim"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "command-template"
},
"totalReferencingInstances": -93414323.20220533,
"totalReferences": -76722247.36883076,
"references": {
"type": "transformation",
"_id": "5eb596edf955d0e5288f84ef",
"name": "irure dolore Duis aliquip ipsum",
"referencePaths": [
"cupidatat Excepteur do cillum enim",
"ea dolor in dolore pariatur",
"laboris commodo"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "workflow"
},
"totalReferencingInstances": 42198497.35479969,
"totalReferences": -53451356.57699567,
"references": {
"type": "form",
"_id": "5eb596edf955d0e5288f84ef",
"name": "est eiusmod cupidatat aliquip occaecat",
"referencePaths": [
"dolore qui dolor magna",
"dolore mollit Ut sint 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"
}
}
}
}
}
}
}
}
}