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": "sed veniam mollit",
"target-identifiers": "Duis sed laboris quis irure",
"referrer-type": "in labore aliqua"
}
}
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": "command-template"
},
"totalReferencingInstances": 28568606.74852957,
"totalReferences": 29013697.034204483,
"references": {
"type": "workflow",
"_id": "5eb596edf955d0e5288f84ef",
"name": "nostrud",
"referencePaths": [
"ullamco labore proident commodo",
"voluptate elit non"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "command-template"
},
"totalReferencingInstances": 81419094.6791211,
"totalReferences": 16210170.001403853,
"references": {
"type": "command-template",
"_id": "5eb596edf955d0e5288f84ef",
"name": "proident",
"referencePaths": [
"ad aliqua ipsum occaecat",
"nulla tempor aute dolor",
"incididunt consectetur",
"consequat aute",
"pariatur sint Lorem"
]
}
},
{
"target": {
"identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
"type": "transformation"
},
"totalReferencingInstances": -24312932.913517177,
"totalReferences": -41872459.647157356,
"references": {
"type": "form",
"_id": "5eb596edf955d0e5288f84ef",
"name": "pariatur magna",
"referencePaths": [
"aliqua sit consequat",
"incididunt commodo elit minim id",
"non occaecat",
"esse consectetur ullamco aliqua sint",
"proident"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "transformation"
},
"totalReferencingInstances": -52845456.05047821,
"totalReferences": 45787684.022437215,
"references": {
"type": "command-template",
"_id": "5eb596edf955d0e5288f84ef",
"name": "laborum eu exercitation",
"referencePaths": [
"incididunt non eiusmod"
]
}
},
{
"target": {
"identifer": "5eb596edf955d0e5288f84ef",
"type": "command-template"
},
"totalReferencingInstances": 23899179.92832169,
"totalReferences": -90406156.4946323,
"references": {
"type": "json-form",
"_id": "5eb596edf955d0e5288f84ef",
"name": "elit ut laboris esse",
"referencePaths": [
"in proident Duis commodo qui"
]
}
}
]
}
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"
}
}
}
}
}
}
}
}
}