Data Formats

The API uses JSON for request and response bodies.

Example Elements Endpoint Request

Copy
Copied
curl -X 'GET' \
  'https://{{ReportingApiDomain}}/api/v1/elements?FacetName=name&Skip=0&Take=100' \
  -H 'accept: application/json' \
  -H 'x-tenant-id: 00000000-0000-0000-0000-000000000000' \
  -H 'x-api-key: api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

Example Elements Endpoint Response

Copy
Copied
{
  "items": [
    [
      {
        "containerPermaLink": "string",
        "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "facetName": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ordering": 0,
        "permaLink": "string",
        "state": "string",
        "stereotype": "string",
        "type": "string",
        "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "attributes": {
          "additionalProp1": {
            "additionalProp1": "string"
          },
          "additionalProp2": {
            "additionalProp1": "string"
          },
          "additionalProp3": {
            "additionalProp1": "string"
          }
        },
        "content": [
          {
            "containerPermaLink": "string",
            "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "facetName": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ordering": 0,
            "permaLink": "string",
            "state": "string",
            "stereotype": "string",
            "type": "string",
            "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "attributes": {
              "additionalProp1": {
                "additionalProp1": "string"
              },
              "additionalProp2": {
                "additionalProp1": "string"
              },
              "additionalProp3": {
                "additionalProp1": "string"
              }
            },
            "content": [
              "string"
            ],
            "related": {
              "additionalProp1": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ],
              "additionalProp2": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ],
              "additionalProp3": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ]
            },
            "children": [
              {
                "containerPermaLink": "string",
                "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "facetName": "string",
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "ordering": 0,
                "permaLink": "string",
                "state": "string",
                "stereotype": "string",
                "type": "string",
                "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "isReference": true,
                "isRootNode": true
              }
            ],
            "isMasterVariant": true,
            "isRootNode": true,
            "rootPath": [
              {
                "containerPermaLink": "string",
                "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "facetName": "string",
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "ordering": 0,
                "permaLink": "string",
                "state": "string",
                "stereotype": "string",
                "type": "string",
                "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "isReference": true,
                "isRootNode": true
              }
            ],
            "supportsVariants": true,
            "supportsVersions": true,
            "variants": [
              {
                "containerPermaLink": "string",
                "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "facetName": "string",
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "ordering": 0,
                "permaLink": "string",
                "state": "string",
                "stereotype": "string",
                "type": "string",
                "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "attributes": {
                  "additionalProp1": {
                    "additionalProp1": "string"
                  },
                  "additionalProp2": {
                    "additionalProp1": "string"
                  },
                  "additionalProp3": {
                    "additionalProp1": "string"
                  }
                },
                "content": [
                  "string"
                ],
                "related": {
                  "additionalProp1": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ],
                  "additionalProp2": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ],
                  "additionalProp3": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ]
                },
                "isMasterVariant": true,
                "supportsVersions": true,
                "versions": [
                  {
                    "containerPermaLink": "string",
                    "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "facetName": "string",
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "ordering": 0,
                    "permaLink": "string",
                    "state": "string",
                    "stereotype": "string",
                    "type": "string",
                    "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "attributes": {
                      "additionalProp1": {
                        "additionalProp1": "string"
                      },
                      "additionalProp2": {
                        "additionalProp1": "string"
                      },
                      "additionalProp3": {
                        "additionalProp1": "string"
                      }
                    },
                    "content": [
                      "string"
                    ],
                    "related": {
                      "additionalProp1": [
                        {
                          "containerPermaLink": "string",
                          "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "facetName": "string",
                          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "ordering": 0,
                          "permaLink": "string",
                          "state": "string",
                          "stereotype": "string",
                          "type": "string",
                          "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "isReference": true,
                          "isRootNode": true
                        }
                      ],
                      "additionalProp2": [
                        {
                          "containerPermaLink": "string",
                          "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "facetName": "string",
                          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "ordering": 0,
                          "permaLink": "string",
                          "state": "string",
                          "stereotype": "string",
                          "type": "string",
                          "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "isReference": true,
                          "isRootNode": true
                        }
                      ],
                      "additionalProp3": [
                        {
                          "containerPermaLink": "string",
                          "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "facetName": "string",
                          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "ordering": 0,
                          "permaLink": "string",
                          "state": "string",
                          "stereotype": "string",
                          "type": "string",
                          "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                          "isReference": true,
                          "isRootNode": true
                        }
                      ]
                    },
                    "isMasterVariant": true
                  }
                ]
              }
            ],
            "versions": [
              {
                "containerPermaLink": "string",
                "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "facetName": "string",
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "ordering": 0,
                "permaLink": "string",
                "state": "string",
                "stereotype": "string",
                "type": "string",
                "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "attributes": {
                  "additionalProp1": {
                    "additionalProp1": "string"
                  },
                  "additionalProp2": {
                    "additionalProp1": "string"
                  },
                  "additionalProp3": {
                    "additionalProp1": "string"
                  }
                },
                "content": [
                  "string"
                ],
                "related": {
                  "additionalProp1": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ],
                  "additionalProp2": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ],
                  "additionalProp3": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ]
                },
                "isMasterVariant": true
              }
            ]
          }
        ],
        "related": {
          "additionalProp1": [
            {
              "containerPermaLink": "string",
              "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "facetName": "string",
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "ordering": 0,
              "permaLink": "string",
              "state": "string",
              "stereotype": "string",
              "type": "string",
              "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "isReference": true,
              "isRootNode": true
            }
          ],
          "additionalProp2": [
            {
              "containerPermaLink": "string",
              "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "facetName": "string",
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "ordering": 0,
              "permaLink": "string",
              "state": "string",
              "stereotype": "string",
              "type": "string",
              "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "isReference": true,
              "isRootNode": true
            }
          ],
          "additionalProp3": [
            {
              "containerPermaLink": "string",
              "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "facetName": "string",
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "ordering": 0,
              "permaLink": "string",
              "state": "string",
              "stereotype": "string",
              "type": "string",
              "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "isReference": true,
              "isRootNode": true
            }
          ]
        },
        "children": [
          {
            "containerPermaLink": "string",
            "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "facetName": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ordering": 0,
            "permaLink": "string",
            "state": "string",
            "stereotype": "string",
            "type": "string",
            "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "isReference": true,
            "isRootNode": true
          }
        ],
        "isMasterVariant": true,
        "isRootNode": true,
        "rootPath": [
          {
            "containerPermaLink": "string",
            "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "facetName": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ordering": 0,
            "permaLink": "string",
            "state": "string",
            "stereotype": "string",
            "type": "string",
            "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "isReference": true,
            "isRootNode": true
          }
        ],
        "supportsVariants": true,
        "supportsVersions": true,
        "variants": [
          {
            "containerPermaLink": "string",
            "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "facetName": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ordering": 0,
            "permaLink": "string",
            "state": "string",
            "stereotype": "string",
            "type": "string",
            "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "attributes": {
              "additionalProp1": {
                "additionalProp1": "string"
              },
              "additionalProp2": {
                "additionalProp1": "string"
              },
              "additionalProp3": {
                "additionalProp1": "string"
              }
            },
            "content": [
              "string"
            ],
            "related": {
              "additionalProp1": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ],
              "additionalProp2": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ],
              "additionalProp3": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ]
            },
            "isMasterVariant": true,
            "supportsVersions": true,
            "versions": [
              {
                "containerPermaLink": "string",
                "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "facetName": "string",
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "ordering": 0,
                "permaLink": "string",
                "state": "string",
                "stereotype": "string",
                "type": "string",
                "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "attributes": {
                  "additionalProp1": {
                    "additionalProp1": "string"
                  },
                  "additionalProp2": {
                    "additionalProp1": "string"
                  },
                  "additionalProp3": {
                    "additionalProp1": "string"
                  }
                },
                "content": [
                  "string"
                ],
                "related": {
                  "additionalProp1": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ],
                  "additionalProp2": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ],
                  "additionalProp3": [
                    {
                      "containerPermaLink": "string",
                      "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "facetName": "string",
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "ordering": 0,
                      "permaLink": "string",
                      "state": "string",
                      "stereotype": "string",
                      "type": "string",
                      "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "isReference": true,
                      "isRootNode": true
                    }
                  ]
                },
                "isMasterVariant": true
              }
            ]
          }
        ],
        "versions": [
          {
            "containerPermaLink": "string",
            "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "facetName": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ordering": 0,
            "permaLink": "string",
            "state": "string",
            "stereotype": "string",
            "type": "string",
            "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "attributes": {
              "additionalProp1": {
                "additionalProp1": "string"
              },
              "additionalProp2": {
                "additionalProp1": "string"
              },
              "additionalProp3": {
                "additionalProp1": "string"
              }
            },
            "content": [
              "string"
            ],
            "related": {
              "additionalProp1": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ],
              "additionalProp2": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ],
              "additionalProp3": [
                {
                  "containerPermaLink": "string",
                  "creationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "facetName": "string",
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "ordering": 0,
                  "permaLink": "string",
                  "state": "string",
                  "stereotype": "string",
                  "type": "string",
                  "variantDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "isReference": true,
                  "isRootNode": true
                }
              ]
            },
            "isMasterVariant": true
          }
        ]
      }
    ]
  ],
  "skip": 0,
  "take": 0,
  "totalCount": 0 // total number of existing records for the request query.
} 

Example Facets Endpoint Request

Copy
Copied
curl -X 'GET' \
  'https://{{ReportingApiDomain}}/api/v1/facets' \
  -H 'accept: application/json' \
  -H 'x-tenant-id: 00000000-0000-0000-0000-000000000000' \
  -H 'x-api-key: api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

Example Facets Endpoint Response

Copy
Copied
{
  "items": [
    [
      {
        "name": "string"
      }
    ]
  ],
  "skip": 0,
  "take": 0,
  "totalCount": 0 // total number of existing records for the request query.

}