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
Details Example Schema
Name
Type
Required
Description
queryParameters
object
yes
Component group id.
Copied to Clipboard
{
"queryParameters": {
"target-type": "Excepteur sit est nulla amet",
"target-identifiers": "cillum nisi officia ea dolor",
"referrer-type": "cillum in 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
Details Example Schema
Name
Type
Description
response
object
Response object.
Copied to Clipboard
{
"referencesByTarget": [
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "form"
},
"totalReferencingInstances": -9727670.351089612,
"totalReferences": -87484638.21626568,
"references": {
"type": "transformation",
"_id": "5eb596edf955d0e5288f84ef",
"name": "aliquip non sunt",
"referencePaths": [
"ex aliquip sunt voluptate",
"in"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "json-form"
},
"totalReferencingInstances": 7854987.072348729,
"totalReferences": -8043060.624871716,
"references": {
"type": "json-form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "aute",
"referencePaths": [
"Lorem fugiat irure in"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "form"
},
"totalReferencingInstances": -37749890.573216185,
"totalReferences": 33525045.07109581,
"references": {
"type": "workflow",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "ut tempor do ea",
"referencePaths": [
"ad irure eu mollit",
"amet ea pariatur",
"laborum"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "command-template"
},
"totalReferencingInstances": 97254017.8091557,
"totalReferences": 57119765.10056046,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "Duis voluptate minim aliquip consequat",
"referencePaths": [
"est eu incididunt Ut aute",
"in deserunt",
"aute deserunt fugiat",
"Duis",
"culpa"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}