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": "amet ad aliquip cupidatat adipisicing",
    "target-identifiers": "aute ad ut",
    "referrer-type": "quis"
  }
}
           
          
            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": "workflow"
      },
      "totalReferencingInstances": -20047773.102060124,
      "totalReferences": 73026506.75497916,
      "references": {
        "type": "workflow",
        "_id": "940a1b4f-399a-44df-a42e-d37da51c7637",
        "name": "aute in sunt",
        "referencePaths": [
          "sint"
        ]
      }
    },
    {
      "target": {
        "identifer": "940a1b4f-399a-44df-a42e-d37da51c7637",
        "type": "workflow"
      },
      "totalReferencingInstances": -70425132.86459747,
      "totalReferences": 84643861.5147107,
      "references": {
        "type": "analytic-template",
        "_id": "5eb596edf955d0e5288f84ef",
        "name": "Excepteur",
        "referencePaths": [
          "occaecat ex sit consequat in",
          "Excepteur ea ullamco magna ad",
          "velit est ut do esse",
          "reprehenderit qui non ex quis"
        ]
      }
    }
  ]
}
           
          
            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"
                }
              }
            }
          }
        }
      }
    }
  }
}