Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Assets

Discover and analyze assets affected by control failures. Use these endpoints to retrieve failed assets for specific controls or across all controls, and drill down to the root cause assets behind a failure. Supports cursor-based pagination and multiple sorting options.

List failed assets for a control

get

Returns a list of assets that have failed the control.

Returns only the assets on which the authenticated user has view permissions.

Authorizations
AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters
controlIdstring · uuidRequired

The unique identifier of the control.

Query parameters
cursorstringOptional

The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call.

If not set, the response starts from the first available resource.

Example: eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInRpbWVzdGFtcCI6MTY5NzM3MjQwMH0=
limitinteger · min: 1 · max: 500Optional

The maximum number of resources to retrieve.

If not set, the default value is 100. The maximum value is 500.

Default: 100
includeTotalbooleanOptional

Whether to include the total number of resources in the response.

If true, the response will include the total number of resources (total), as well as a boolean indicating if the total is approximate (isTotalApproximate).

If false, the response will not include the total number of resources (total and isTotalApproximate).

Default: true
sortFieldstring · enumOptional

The field on which the failed assets are sorted. The default value is NAME.

Default: NAMEPossible values:
sortOrderstring · enumOptional

The sorting order. The default value is ASC.

Default: ASCPossible values:
Responses
200

Response containing the failed assets for a specific control with pagination support.

application/json

A paginated response containing assets that have failed the control.

nextCursorstringOptional

Cursor pointing to the next page. If missing, this means that there are no additional pages of resources available after the current one.

Example: eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInRpbWVzdGFtcCI6MTY5NzM3MjQwMH0=
totalintegerOptional

The total number of resources matching the request.

Example: 100
isTotalApproximatebooleanOptional

Indicates if the total is approximate. Failed asset counts stop at 1000: beyond that the API reports 1000 with this flag set to true. Failed control counts are always exact, so this is always false for them.

Example: false
get/controls/{controlId}/assets/failed
GET /rest/controlExecution/v1/controls/{controlId}/assets/failed HTTP/1.1
Authorization: Basic username:password
Accept: */*
{
  "nextCursor": "eyJpZCI6IjU1MGU4NDAw",
  "total": 26,
  "isTotalApproximate": false,
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "name": "Customer Database",
      "description": "Primary database containing customer information and transaction data",
      "control": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Database Encryption Check"
      },
      "community": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "name": "Data Management"
      },
      "assetType": {
        "id": "9f8e7d6c-5b4a-3928-1756-483920172635",
        "name": "Database"
      }
    },
    {
      "id": "f1e2d3c4-b5a6-9870-2143-678901bcdef0",
      "name": "Financial Reporting Database",
      "description": "Database storing financial reports and compliance data",
      "control": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Database Encryption Check"
      },
      "community": {
        "id": "3c8f4b2a-5e60-4088-97f1-b59b396d871e",
        "name": "Finance"
      },
      "assetType": {
        "id": "9f8e7d6c-5b4a-3928-1756-483920172635",
        "name": "Database"
      }
    },
    {
      "id": "7a8b9c0d-1e2f-3456-7890-abcdef123456",
      "name": "HR Personnel Data Store",
      "description": "Data store containing employee personal information and HR records",
      "control": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Database Encryption Check"
      },
      "community": {
        "id": "4d9a5c3b-6f71-5199-a8a2-c60c407e982f",
        "name": "Human Resources"
      },
      "assetType": {
        "id": "8e7d6c5b-4a39-2817-0645-392817263548",
        "name": "Data Store"
      }
    }
  ]
}

List root cause assets for a control, failed asset, and requirement

get

Returns a list of root cause assets that are causing a specific asset to fail a given requirement of a control. The ID of the requirement is provided as a query parameter (See requirementId). The requirement IDs are returned by the getControlRequirements endpoint of the Control Tower Management API.

Root cause assets are the underlying assets that directly contribute to the control failure (based on the requirements defined in the query). For example, if a table fails a data quality control, the root cause assets might be the specific columns or fields within that table that contain the problematic data.

Returns only the root cause assets on which the authenticated user has view permissions.

Authorizations
AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters
controlIdstring · uuidRequired

The unique identifier of the control.

assetIdstring · uuidRequired

The unique identifier of the asset.

Query parameters
requirementIdstring · min: 17 · max: 17Required

The ID of a requirement is a 17-characters string that combines the versionHash of the parent Control Query with the versionHash of the Filter marked as a requirement. The 2 hashes are - separated.

For example:

  • versionHash of the ControlQuery is ba7816bf
  • versionHash of the Filter is cd294a01
  • The identifier of the requirement is ba7816bf-cd294a01

The requirement IDs are returned by the getControlRequirements endpoint of the Control Tower Management API.

Example: ba7816bf-cd294a01
cursorstringOptional

The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call.

If not set, the response starts from the first available resource.

Example: eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInRpbWVzdGFtcCI6MTY5NzM3MjQwMH0=
limitinteger · min: 1 · max: 500Optional

The maximum number of resources to retrieve.

If not set, the default value is 100. The maximum value is 500.

Default: 100
Responses
200

Response containing the root cause assets for a specific failed asset of a control with cursor-based pagination.

application/json

A paginated response containing root cause assets with cursor-based pagination.

nextCursorstringOptional

Cursor pointing to the next page. If missing, this means that there are no additional pages of resources available after the current one.

Example: eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInRpbWVzdGFtcCI6MTY5NzM3MjQwMH0=
lagStatusstring · nullableOptional

Indicates how up-to-date the data backing this query is, relative to the latest committed state. Known values: CURRENT, SLIGHTLY_BEHIND, MODERATELY_BEHIND, HEAVILY_BEHIND, CRITICALLY_BEHIND, UNKNOWN. Null if the value was unavailable. For paginated responses, this reflects the state at the time the current page was fetched and may differ across pages.

Example: CURRENT
lastCommittedOnstring · nullableOptional

The timestamp of the last committed state that the data backing this query reflects. Null if the value was unavailable or could not be parsed. For paginated responses, this reflects the state at the time the current page was fetched and may differ across pages.

Example: 2026-06-24T10:00:00Z
get/controls/{controlId}/assets/{assetId}/rootCauseAssets
GET /rest/controlExecution/v1/controls/{controlId}/assets/{assetId}/rootCauseAssets?requirementId=ba7816bf-cd294a01 HTTP/1.1
Authorization: Basic username:password
Accept: */*
{
  "results": [
    {
      "id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
      "name": "Customer Email Column",
      "domain": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "name": "Data Management"
      },
      "assetType": {
        "id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
        "name": "Column",
        "symbol": {
          "acronymCode": "COL",
          "color": "#FF5722",
          "iconCode": "uf-additional-icon-database_column",
          "symbolType": "ICON_CODE"
        }
      }
    },
    {
      "id": "d4e5f6a7-b8c9-0123-4567-890123def012",
      "name": "User Address Field",
      "domain": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "name": "Data Management"
      },
      "assetType": {
        "id": "2b3c4d5e-6f78-90ab-cdef-012345678901",
        "name": "Field",
        "symbol": {
          "acronymCode": "FLD",
          "color": "#4CAF50",
          "iconCode": "uf-additional-icon-field",
          "symbolType": "ICON_CODE"
        }
      }
    },
    {
      "id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
      "name": "Order Details Table",
      "domain": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "name": "Data Management"
      },
      "assetType": {
        "id": "3c4d5e6f-7890-abcd-ef01-23456789012a",
        "name": "Table",
        "symbol": {
          "acronymCode": "TBL",
          "color": "#2196F3",
          "iconCode": "uf-additional-icon-database_table",
          "symbolType": "ICON_CODE"
        }
      }
    }
  ]
}

List all failed assets

get

Returns a list of all assets that have failed.

Authorizations
AuthorizationstringRequired

This API requires Basic HTTP authentication.

Query parameters
cursorstringOptional

The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call.

If not set, the response starts from the first available resource.

Example: eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInRpbWVzdGFtcCI6MTY5NzM3MjQwMH0=
limitinteger · min: 1 · max: 500Optional

The maximum number of resources to retrieve.

If not set, the default value is 100. The maximum value is 500.

Default: 100
includeTotalbooleanOptional

Whether to include the total number of resources in the response.

If true, the response will include the total number of resources (total), as well as a boolean indicating if the total is approximate (isTotalApproximate).

If false, the response will not include the total number of resources (total and isTotalApproximate).

Default: true
sortFieldstring · enumOptional

The field on which the failed assets are sorted. The default value is NAME.

Default: NAMEPossible values:
sortOrderstring · enumOptional

The sorting order. The default value is ASC.

Default: ASCPossible values:
Responses
200

Response containing the failed assets for a specific control with pagination support.

application/json

A paginated response containing assets that have failed the control.

nextCursorstringOptional

Cursor pointing to the next page. If missing, this means that there are no additional pages of resources available after the current one.

Example: eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInRpbWVzdGFtcCI6MTY5NzM3MjQwMH0=
totalintegerOptional

The total number of resources matching the request.

Example: 100
isTotalApproximatebooleanOptional

Indicates if the total is approximate. Failed asset counts stop at 1000: beyond that the API reports 1000 with this flag set to true. Failed control counts are always exact, so this is always false for them.

Example: false
get/assets/failed
GET /rest/controlExecution/v1/assets/failed HTTP/1.1
Authorization: Basic username:password
Accept: */*
{
  "nextCursor": "eyJpZCI6IjU1MGU4NDAw",
  "total": 26,
  "isTotalApproximate": false,
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "name": "Customer Database",
      "description": "Primary database containing customer information and transaction data",
      "control": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Database Encryption Check"
      },
      "community": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "name": "Data Management"
      },
      "assetType": {
        "id": "9f8e7d6c-5b4a-3928-1756-483920172635",
        "name": "Database"
      }
    },
    {
      "id": "f1e2d3c4-b5a6-9870-2143-678901bcdef0",
      "name": "Financial Reporting Database",
      "description": "Database storing financial reports and compliance data",
      "control": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Database Encryption Check"
      },
      "community": {
        "id": "3c8f4b2a-5e60-4088-97f1-b59b396d871e",
        "name": "Finance"
      },
      "assetType": {
        "id": "9f8e7d6c-5b4a-3928-1756-483920172635",
        "name": "Database"
      }
    },
    {
      "id": "7a8b9c0d-1e2f-3456-7890-abcdef123456",
      "name": "HR Personnel Data Store",
      "description": "Data store containing employee personal information and HR records",
      "control": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Database Encryption Check"
      },
      "community": {
        "id": "4d9a5c3b-6f71-5199-a8a2-c60c407e982f",
        "name": "Human Resources"
      },
      "assetType": {
        "id": "8e7d6c5b-4a39-2817-0645-392817263548",
        "name": "Data Store"
      }
    }
  ]
}

Last updated

Was this helpful?