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": "cupidatat mollit dolore",
"target-identifiers": "dolore ea incididunt amet",
"referrer-type": "in laboris veniam"
}
}
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": "json-form"
},
"totalReferencingInstances": 16514165.274410024,
"totalReferences": 42436135.28478059,
"references": {
"type": "transformation",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "labore",
"referencePaths": [
"consectetur in deserunt",
"fugiat"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "workflow"
},
"totalReferencingInstances": -21341383.48401895,
"totalReferences": -2017947.3926720768,
"references": {
"type": "json-form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "reprehenderit deserunt non nostrud",
"referencePaths": [
"commodo dolor laborum reprehenderit dolore",
"quis eiusmod tempor",
"quis",
"dolor proident Lorem"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "workflow"
},
"totalReferencingInstances": -28247519.648379445,
"totalReferences": -66005178.23525047,
"references": {
"type": "command-template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "id aute",
"referencePaths": [
"dolore mollit occaecat sit labore",
"ex ea"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "command-template"
},
"totalReferencingInstances": -51189687.62396619,
"totalReferences": -28746588.127700165,
"references": {
"type": "command-template",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "in ad ea sint nulla",
"referencePaths": [
"ad adipisicing enim"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "transformation"
},
"totalReferencingInstances": 14940776.492104784,
"totalReferences": 86228140.42678577,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "mollit id voluptate amet",
"referencePaths": [
"ullamco incididunt anim",
"occaecat elit",
"voluptate nisi eiusmod eu",
"laboris Lorem ipsum",
"veniam cupidatat aliqua"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}