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": "officia magna Excepteur culpa",
"target-identifiers": "officia in dolor velit ullamco",
"referrer-type": "ex labore"
}
}
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": "form"
},
"totalReferencingInstances": 71786144.61611784,
"totalReferences": -13208334.076286301,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "nisi in do",
"referencePaths": [
"sit cupidatat mollit",
"anim do"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "form"
},
"totalReferencingInstances": 26866675.046178564,
"totalReferences": 96031228.86857319,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "eu",
"referencePaths": [
"voluptate fugiat",
"ut reprehenderit sint adipisicing"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "transformation"
},
"totalReferencingInstances": -97878982.4408266,
"totalReferences": 47331687.63288048,
"references": {
"type": "form",
"_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
"name": "in",
"referencePaths": [
"esse non",
"aliquip in in minim",
"qui",
"incididunt eiusmod eu",
"in occaecat velit Lorem"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "json-form"
},
"totalReferencingInstances": 81220611.46995136,
"totalReferences": -77993444.75645298,
"references": {
"type": "form",
"_id": "5eb596edf955d0e5288f84ef",
"name": "pariatur cillum",
"referencePaths": [
"Lorem in",
"proident do adipisicing"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}