> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/control-execution/models.md).

# Models

## The Total object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"Total":{"type":"integer","description":"The total number of resources matching the request."}}}}
```

## The TotalApproximate object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"TotalApproximate":{"type":"boolean","description":"Indicates if the total is approximate. Failed asset counts stop at 1000: beyond that the API reports `1000`\nwith this flag set to `true`. Failed control counts are always exact, so this is always `false` for them.\n"}}}}
```

## The ControlExecutionOutcome object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"ControlExecutionOutcome":{"description":"Represents the outcome of a control execution. The currently defined outcomes are `Pass`, `Fail`, and `Unknown`.\n","type":"string"}}}}
```

## The ControlExecutionStatus object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"ControlExecutionStatus":{"description":"Schema for a control status execution.","type":"object","properties":{"controlStatus":{"$ref":"#/components/schemas/ControlExecutionOutcome"},"failedAssetCount":{"$ref":"#/components/schemas/FailedAssetCount"},"lastExecutedOn":{"description":"The timestamp when the control execution was last executed. Absent when the control has never completed an execution.","type":"string","format":"date-time"}},"required":["controlStatus"]},"ControlExecutionOutcome":{"description":"Represents the outcome of a control execution. The currently defined outcomes are `Pass`, `Fail`, and `Unknown`.\n","type":"string"},"FailedAssetCount":{"type":"integer","description":"The number of assets that have failed the control."}}}}
```

## The PaginatedFailedAssets object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"PaginatedFailedAssets":{"type":"object","description":"A paginated response containing assets that have failed the control.\n","required":["results"],"properties":{"nextCursor":{"$ref":"#/components/schemas/NextCursor"},"total":{"$ref":"#/components/schemas/Total"},"isTotalApproximate":{"$ref":"#/components/schemas/TotalApproximate"},"results":{"description":"Array of failed assets.","type":"array","items":{"$ref":"#/components/schemas/FailedAsset"}}}},"NextCursor":{"description":"Cursor pointing to the next page. If missing, this means that there are no additional pages of resources\navailable after the current one.\n","type":"string"},"Total":{"type":"integer","description":"The total number of resources matching the request."},"TotalApproximate":{"type":"boolean","description":"Indicates if the total is approximate. Failed asset counts stop at 1000: beyond that the API reports `1000`\nwith this flag set to `true`. Failed control counts are always exact, so this is always `false` for them.\n"},"FailedAsset":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"type":"object","properties":{"description":{"type":"string","description":"The description of the asset."},"control":{"$ref":"#/components/schemas/ControlReference"},"community":{"$ref":"#/components/schemas/CommunityReference"},"parentCommunity":{"allOf":[{"$ref":"#/components/schemas/CommunityReference"},{"deprecated":true,"description":"Deprecated. Use `community` instead. Returns the same value as `community`."}]}}}]},"Asset":{"type":"object","description":"An asset of the Knowledge Graph.\n","required":["id","name","assetType"],"properties":{"id":{"type":"string","description":"The unique identifier of the asset.","format":"uuid"},"name":{"type":"string","description":"The name of the asset."},"assetType":{"$ref":"#/components/schemas/AssetType"}}},"AssetType":{"type":"object","description":"Represents an asset type reference.","properties":{"id":{"description":"The ID of the asset type.","format":"uuid","type":"string"},"name":{"description":"The name of the asset type.","type":"string"},"symbol":{"$ref":"#/components/schemas/SymbolData"}},"required":["id","name"]},"SymbolData":{"description":"The symbol data of the type.","type":"object","required":["acronymCode","color","symbolType"],"properties":{"acronymCode":{"type":"string","description":"The acronym code of the symbol.\n"},"color":{"type":"string","description":"The hex color code of the symbol.\n"},"iconCode":{"type":"string","description":"The icon code of the symbol.\n"},"symbolType":{"$ref":"#/components/schemas/SymbolType"}}},"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"},"ControlReference":{"type":"object","description":"Represents a control reference.","properties":{"id":{"description":"The ID of the control.","format":"uuid","type":"string"},"name":{"description":"The name of the control.","type":"string"}},"required":["id","name"]},"CommunityReference":{"type":"object","description":"Represents a community reference.","properties":{"id":{"description":"The ID of the community.","format":"uuid","type":"string"},"name":{"description":"The name of the community.","type":"string"}},"required":["id","name"]}}}}
```

## The PaginatedFailedControls object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"PaginatedFailedControls":{"type":"object","description":"A paginated response containing controls that have failed for an asset.\n","required":["results"],"properties":{"nextCursor":{"$ref":"#/components/schemas/NextCursor"},"total":{"$ref":"#/components/schemas/Total"},"isTotalApproximate":{"$ref":"#/components/schemas/TotalApproximate"},"results":{"description":"Array of failed controls for the current page.","type":"array","items":{"$ref":"#/components/schemas/FailedControl"}}}},"NextCursor":{"description":"Cursor pointing to the next page. If missing, this means that there are no additional pages of resources\navailable after the current one.\n","type":"string"},"Total":{"type":"integer","description":"The total number of resources matching the request."},"TotalApproximate":{"type":"boolean","description":"Indicates if the total is approximate. Failed asset counts stop at 1000: beyond that the API reports `1000`\nwith this flag set to `true`. Failed control counts are always exact, so this is always `false` for them.\n"},"FailedControl":{"type":"object","description":"A control that has failed for an asset.\n","properties":{"id":{"$ref":"#/components/schemas/ControlId"},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"severity":{"$ref":"#/components/schemas/ControlSeverity"},"controlType":{"$ref":"#/components/schemas/ControlType"},"failedSince":{"$ref":"#/components/schemas/FailureTimestamp"}}},"ControlId":{"type":"string","format":"uuid","description":"The unique identifier of the control."},"ControlName":{"type":"string","description":"The name of the control."},"ControlDescription":{"type":"string","description":"The description of the control."},"ControlSeverity":{"type":"string","description":"The severity of the control.\n\nThe possible values are:\n- Low\n- Medium\n- High\n"},"ControlType":{"type":"string","description":"The type of the control."},"FailureTimestamp":{"type":"string","format":"date-time","description":"The timestamp when the control first failed for this asset."}}}}
```

## The Asset object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"Asset":{"type":"object","description":"An asset of the Knowledge Graph.\n","required":["id","name","assetType"],"properties":{"id":{"type":"string","description":"The unique identifier of the asset.","format":"uuid"},"name":{"type":"string","description":"The name of the asset."},"assetType":{"$ref":"#/components/schemas/AssetType"}}},"AssetType":{"type":"object","description":"Represents an asset type reference.","properties":{"id":{"description":"The ID of the asset type.","format":"uuid","type":"string"},"name":{"description":"The name of the asset type.","type":"string"},"symbol":{"$ref":"#/components/schemas/SymbolData"}},"required":["id","name"]},"SymbolData":{"description":"The symbol data of the type.","type":"object","required":["acronymCode","color","symbolType"],"properties":{"acronymCode":{"type":"string","description":"The acronym code of the symbol.\n"},"color":{"type":"string","description":"The hex color code of the symbol.\n"},"iconCode":{"type":"string","description":"The icon code of the symbol.\n"},"symbolType":{"$ref":"#/components/schemas/SymbolType"}}},"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"}}}}
```

## The AssetWithDomain object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"AssetWithDomain":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"type":"object","required":["domain"],"properties":{"domain":{"$ref":"#/components/schemas/DomainReference"}}}]},"Asset":{"type":"object","description":"An asset of the Knowledge Graph.\n","required":["id","name","assetType"],"properties":{"id":{"type":"string","description":"The unique identifier of the asset.","format":"uuid"},"name":{"type":"string","description":"The name of the asset."},"assetType":{"$ref":"#/components/schemas/AssetType"}}},"AssetType":{"type":"object","description":"Represents an asset type reference.","properties":{"id":{"description":"The ID of the asset type.","format":"uuid","type":"string"},"name":{"description":"The name of the asset type.","type":"string"},"symbol":{"$ref":"#/components/schemas/SymbolData"}},"required":["id","name"]},"SymbolData":{"description":"The symbol data of the type.","type":"object","required":["acronymCode","color","symbolType"],"properties":{"acronymCode":{"type":"string","description":"The acronym code of the symbol.\n"},"color":{"type":"string","description":"The hex color code of the symbol.\n"},"iconCode":{"type":"string","description":"The icon code of the symbol.\n"},"symbolType":{"$ref":"#/components/schemas/SymbolType"}}},"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"},"DomainReference":{"type":"object","description":"Represents a domain reference.","properties":{"id":{"description":"The ID of the domain.","format":"uuid","type":"string"},"name":{"description":"The name of the domain.","type":"string"}},"required":["id","name"]}}}}
```

## The RootCauseAsset object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"RootCauseAsset":{"description":"An asset that causes the control to fail for a given asset.\n","allOf":[{"$ref":"#/components/schemas/AssetWithDomain"}]},"AssetWithDomain":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"type":"object","required":["domain"],"properties":{"domain":{"$ref":"#/components/schemas/DomainReference"}}}]},"Asset":{"type":"object","description":"An asset of the Knowledge Graph.\n","required":["id","name","assetType"],"properties":{"id":{"type":"string","description":"The unique identifier of the asset.","format":"uuid"},"name":{"type":"string","description":"The name of the asset."},"assetType":{"$ref":"#/components/schemas/AssetType"}}},"AssetType":{"type":"object","description":"Represents an asset type reference.","properties":{"id":{"description":"The ID of the asset type.","format":"uuid","type":"string"},"name":{"description":"The name of the asset type.","type":"string"},"symbol":{"$ref":"#/components/schemas/SymbolData"}},"required":["id","name"]},"SymbolData":{"description":"The symbol data of the type.","type":"object","required":["acronymCode","color","symbolType"],"properties":{"acronymCode":{"type":"string","description":"The acronym code of the symbol.\n"},"color":{"type":"string","description":"The hex color code of the symbol.\n"},"iconCode":{"type":"string","description":"The icon code of the symbol.\n"},"symbolType":{"$ref":"#/components/schemas/SymbolType"}}},"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"},"DomainReference":{"type":"object","description":"Represents a domain reference.","properties":{"id":{"description":"The ID of the domain.","format":"uuid","type":"string"},"name":{"description":"The name of the domain.","type":"string"}},"required":["id","name"]}}}}
```

## The FailedAsset object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"FailedAsset":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"type":"object","properties":{"description":{"type":"string","description":"The description of the asset."},"control":{"$ref":"#/components/schemas/ControlReference"},"community":{"$ref":"#/components/schemas/CommunityReference"},"parentCommunity":{"allOf":[{"$ref":"#/components/schemas/CommunityReference"},{"deprecated":true,"description":"Deprecated. Use `community` instead. Returns the same value as `community`."}]}}}]},"Asset":{"type":"object","description":"An asset of the Knowledge Graph.\n","required":["id","name","assetType"],"properties":{"id":{"type":"string","description":"The unique identifier of the asset.","format":"uuid"},"name":{"type":"string","description":"The name of the asset."},"assetType":{"$ref":"#/components/schemas/AssetType"}}},"AssetType":{"type":"object","description":"Represents an asset type reference.","properties":{"id":{"description":"The ID of the asset type.","format":"uuid","type":"string"},"name":{"description":"The name of the asset type.","type":"string"},"symbol":{"$ref":"#/components/schemas/SymbolData"}},"required":["id","name"]},"SymbolData":{"description":"The symbol data of the type.","type":"object","required":["acronymCode","color","symbolType"],"properties":{"acronymCode":{"type":"string","description":"The acronym code of the symbol.\n"},"color":{"type":"string","description":"The hex color code of the symbol.\n"},"iconCode":{"type":"string","description":"The icon code of the symbol.\n"},"symbolType":{"$ref":"#/components/schemas/SymbolType"}}},"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"},"ControlReference":{"type":"object","description":"Represents a control reference.","properties":{"id":{"description":"The ID of the control.","format":"uuid","type":"string"},"name":{"description":"The name of the control.","type":"string"}},"required":["id","name"]},"CommunityReference":{"type":"object","description":"Represents a community reference.","properties":{"id":{"description":"The ID of the community.","format":"uuid","type":"string"},"name":{"description":"The name of the community.","type":"string"}},"required":["id","name"]}}}}
```

## The ControlId object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"ControlId":{"type":"string","format":"uuid","description":"The unique identifier of the control."}}}}
```

## The ControlName object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"ControlName":{"type":"string","description":"The name of the control."}}}}
```

## The ControlDescription object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"ControlDescription":{"type":"string","description":"The description of the control."}}}}
```

## The ControlSeverity object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"ControlSeverity":{"type":"string","description":"The severity of the control.\n\nThe possible values are:\n- Low\n- Medium\n- High\n"}}}}
```

## The ControlType object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"ControlType":{"type":"string","description":"The type of the control."}}}}
```

## The FailureTimestamp object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"FailureTimestamp":{"type":"string","format":"date-time","description":"The timestamp when the control first failed for this asset."}}}}
```

## The FailedAssetCount object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"FailedAssetCount":{"type":"integer","description":"The number of assets that have failed the control."}}}}
```

## The FailedControl object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"FailedControl":{"type":"object","description":"A control that has failed for an asset.\n","properties":{"id":{"$ref":"#/components/schemas/ControlId"},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"severity":{"$ref":"#/components/schemas/ControlSeverity"},"controlType":{"$ref":"#/components/schemas/ControlType"},"failedSince":{"$ref":"#/components/schemas/FailureTimestamp"}}},"ControlId":{"type":"string","format":"uuid","description":"The unique identifier of the control."},"ControlName":{"type":"string","description":"The name of the control."},"ControlDescription":{"type":"string","description":"The description of the control."},"ControlSeverity":{"type":"string","description":"The severity of the control.\n\nThe possible values are:\n- Low\n- Medium\n- High\n"},"ControlType":{"type":"string","description":"The type of the control."},"FailureTimestamp":{"type":"string","format":"date-time","description":"The timestamp when the control first failed for this asset."}}}}
```

## The AssetType object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"AssetType":{"type":"object","description":"Represents an asset type reference.","properties":{"id":{"description":"The ID of the asset type.","format":"uuid","type":"string"},"name":{"description":"The name of the asset type.","type":"string"},"symbol":{"$ref":"#/components/schemas/SymbolData"}},"required":["id","name"]},"SymbolData":{"description":"The symbol data of the type.","type":"object","required":["acronymCode","color","symbolType"],"properties":{"acronymCode":{"type":"string","description":"The acronym code of the symbol.\n"},"color":{"type":"string","description":"The hex color code of the symbol.\n"},"iconCode":{"type":"string","description":"The icon code of the symbol.\n"},"symbolType":{"$ref":"#/components/schemas/SymbolType"}}},"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"}}}}
```

## The CommunityReference object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"CommunityReference":{"type":"object","description":"Represents a community reference.","properties":{"id":{"description":"The ID of the community.","format":"uuid","type":"string"},"name":{"description":"The name of the community.","type":"string"}},"required":["id","name"]}}}}
```

## The DomainReference object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"DomainReference":{"type":"object","description":"Represents a domain reference.","properties":{"id":{"description":"The ID of the domain.","format":"uuid","type":"string"},"name":{"description":"The name of the domain.","type":"string"}},"required":["id","name"]}}}}
```

## The ControlReference object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"ControlReference":{"type":"object","description":"Represents a control reference.","properties":{"id":{"description":"The ID of the control.","format":"uuid","type":"string"},"name":{"description":"The name of the control.","type":"string"}},"required":["id","name"]}}}}
```

## The NextCursor object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"NextCursor":{"description":"Cursor pointing to the next page. If missing, this means that there are no additional pages of resources\navailable after the current one.\n","type":"string"}}}}
```

## The StandardErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"StandardErrorResponse":{"description":"A standard error response object.\n\n`titleMessage`, `helpMessage` and `userMessage` all carry the same text: the reason phrase of the status code\nfor `5xx` responses, and the error detail for `4xx` responses. Do not rely on them differing.\n","type":"object","properties":{"statusCode":{"description":"HTTP response code.","type":"integer"},"titleMessage":{"description":"The error message. Same text as `helpMessage` and `userMessage`.\n","type":"string"},"helpMessage":{"description":"The error message. Same text as `titleMessage` and `userMessage`.\n","type":"string"},"userMessage":{"description":"The error message. Same text as `titleMessage` and `helpMessage`.\n","type":"string"},"errorCode":{"description":"An error code identifier. Unless the individual response documents otherwise, this is the name of the\nHTTP status, such as `BAD_REQUEST` or `INTERNAL_SERVER_ERROR`.\n","type":"string"}},"required":["statusCode","errorCode","userMessage"]}}}}
```

## The SymbolType object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"}}}}
```

## The SymbolData object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"SymbolData":{"description":"The symbol data of the type.","type":"object","required":["acronymCode","color","symbolType"],"properties":{"acronymCode":{"type":"string","description":"The acronym code of the symbol.\n"},"color":{"type":"string","description":"The hex color code of the symbol.\n"},"iconCode":{"type":"string","description":"The icon code of the symbol.\n"},"symbolType":{"$ref":"#/components/schemas/SymbolType"}}},"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"}}}}
```

## The PaginatedRootCauseAssets object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"PaginatedRootCauseAssets":{"type":"object","description":"A paginated response containing root cause assets with cursor-based pagination.\n","required":["results"],"properties":{"nextCursor":{"$ref":"#/components/schemas/NextCursor"},"results":{"type":"array","description":"Array of root cause assets for the current page.","items":{"$ref":"#/components/schemas/RootCauseAsset"}},"lagStatus":{"$ref":"#/components/schemas/QueryLagStatus"},"lastCommittedOn":{"$ref":"#/components/schemas/QueryLastCommittedOn"}}},"NextCursor":{"description":"Cursor pointing to the next page. If missing, this means that there are no additional pages of resources\navailable after the current one.\n","type":"string"},"RootCauseAsset":{"description":"An asset that causes the control to fail for a given asset.\n","allOf":[{"$ref":"#/components/schemas/AssetWithDomain"}]},"AssetWithDomain":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"type":"object","required":["domain"],"properties":{"domain":{"$ref":"#/components/schemas/DomainReference"}}}]},"Asset":{"type":"object","description":"An asset of the Knowledge Graph.\n","required":["id","name","assetType"],"properties":{"id":{"type":"string","description":"The unique identifier of the asset.","format":"uuid"},"name":{"type":"string","description":"The name of the asset."},"assetType":{"$ref":"#/components/schemas/AssetType"}}},"AssetType":{"type":"object","description":"Represents an asset type reference.","properties":{"id":{"description":"The ID of the asset type.","format":"uuid","type":"string"},"name":{"description":"The name of the asset type.","type":"string"},"symbol":{"$ref":"#/components/schemas/SymbolData"}},"required":["id","name"]},"SymbolData":{"description":"The symbol data of the type.","type":"object","required":["acronymCode","color","symbolType"],"properties":{"acronymCode":{"type":"string","description":"The acronym code of the symbol.\n"},"color":{"type":"string","description":"The hex color code of the symbol.\n"},"iconCode":{"type":"string","description":"The icon code of the symbol.\n"},"symbolType":{"$ref":"#/components/schemas/SymbolType"}}},"SymbolType":{"description":"The symbol type.\n","enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"},"DomainReference":{"type":"object","description":"Represents a domain reference.","properties":{"id":{"description":"The ID of the domain.","format":"uuid","type":"string"},"name":{"description":"The name of the domain.","type":"string"}},"required":["id","name"]},"QueryLagStatus":{"type":["string","null"],"description":"Indicates how up-to-date the data backing this query is, relative to the latest committed\nstate. Known values: CURRENT, SLIGHTLY_BEHIND, MODERATELY_BEHIND, HEAVILY_BEHIND,\nCRITICALLY_BEHIND, UNKNOWN. Null if the value was unavailable. For paginated responses,\nthis reflects the state at the time the current page was fetched and may differ across pages.\n"},"QueryLastCommittedOn":{"type":["string","null"],"format":"date-time","description":"The timestamp of the last committed state that the data backing this query reflects. Null if\nthe value was unavailable or could not be parsed. For paginated responses, this reflects the\nstate at the time the current page was fetched and may differ across pages.\n"}}}}
```

## The QueryLagStatus object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"QueryLagStatus":{"type":["string","null"],"description":"Indicates how up-to-date the data backing this query is, relative to the latest committed\nstate. Known values: CURRENT, SLIGHTLY_BEHIND, MODERATELY_BEHIND, HEAVILY_BEHIND,\nCRITICALLY_BEHIND, UNKNOWN. Null if the value was unavailable. For paginated responses,\nthis reflects the state at the time the current page was fetched and may differ across pages.\n"}}}}
```

## The QueryLastCommittedOn object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"QueryLastCommittedOn":{"type":["string","null"],"format":"date-time","description":"The timestamp of the last committed state that the data backing this query reflects. Null if\nthe value was unavailable or could not be parsed. For paginated responses, this reflects the\nstate at the time the current page was fetched and may differ across pages.\n"}}}}
```

## The Job object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"Job":{"type":"object","description":"A `Job` represents the execution chain for a single on-demand control run, consisting of three background\nsteps: fetching failed assets, sending notifications, and updating the execution status in the knowledge\ngraph.\n","required":["id","type","state","details"],"properties":{"id":{"$ref":"#/components/schemas/JobId"},"type":{"$ref":"#/components/schemas/JobType"},"state":{"$ref":"#/components/schemas/JobState"},"details":{"$ref":"#/components/schemas/JobDetails"},"endDate":{"$ref":"#/components/schemas/JobEndDate"},"failureMessage":{"$ref":"#/components/schemas/JobFailureMessage"}}},"JobId":{"description":"The ID of the job.\n","type":"string","format":"uuid"},"JobType":{"description":"The type of the job.\n\nThe only supported value is `ControlExecutionJob`.\n","type":"string"},"JobState":{"description":"State of the execution chain.\n\nThe current values are:\n - waiting: the first step has been accepted and is waiting to be picked up\n - running: at least one step is running or waiting to run\n - completed: all three steps finished successfully\n - failed: at least one step failed permanently\n","type":"string"},"JobDetails":{"type":"object","description":"Per-step completion flags for the execution chain.","required":["failedAssetsFetched","statusUpdatedInKnowledgeGraph","notificationTriggered"],"properties":{"failedAssetsFetched":{"type":"boolean","description":"True once the first step (fetching failed assets) has completed successfully."},"statusUpdatedInKnowledgeGraph":{"type":"boolean","description":"True once the execution status has been updated in the knowledge graph."},"notificationTriggered":{"type":"boolean","description":"True once the notification step has completed successfully."},"failedStep":{"type":"string","description":"Present only when state is `failed`. Identifies the step that failed permanently.\n\nThe current values are:\n - process-control-query\n - send-control-notifications\n - update-control-execution-status\n"}}},"JobEndDate":{"description":"The completion date and time of the execution job. Indicates when the job transitioned to either `complete` or\n`failed`\n","type":"string","format":"date-time"},"JobFailureMessage":{"description":"A user-facing message indicating that the job has failed. Only present when the job state is `failed`.\n","type":"string"}}}}
```

## The JobType object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"JobType":{"description":"The type of the job.\n\nThe only supported value is `ControlExecutionJob`.\n","type":"string"}}}}
```

## The JobId object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"JobId":{"description":"The ID of the job.\n","type":"string","format":"uuid"}}}}
```

## The JobState object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"JobState":{"description":"State of the execution chain.\n\nThe current values are:\n - waiting: the first step has been accepted and is waiting to be picked up\n - running: at least one step is running or waiting to run\n - completed: all three steps finished successfully\n - failed: at least one step failed permanently\n","type":"string"}}}}
```

## The JobEndDate object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"JobEndDate":{"description":"The completion date and time of the execution job. Indicates when the job transitioned to either `complete` or\n`failed`\n","type":"string","format":"date-time"}}}}
```

## The JobFailureMessage object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"JobFailureMessage":{"description":"A user-facing message indicating that the job has failed. Only present when the job state is `failed`.\n","type":"string"}}}}
```

## The JobDetails object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Execution API","version":"1.0.0"},"components":{"schemas":{"JobDetails":{"type":"object","description":"Per-step completion flags for the execution chain.","required":["failedAssetsFetched","statusUpdatedInKnowledgeGraph","notificationTriggered"],"properties":{"failedAssetsFetched":{"type":"boolean","description":"True once the first step (fetching failed assets) has completed successfully."},"statusUpdatedInKnowledgeGraph":{"type":"boolean","description":"True once the execution status has been updated in the knowledge graph."},"notificationTriggered":{"type":"boolean","description":"True once the notification step has completed successfully."},"failedStep":{"type":"string","description":"Present only when state is `failed`. Identifies the step that failed permanently.\n\nThe current values are:\n - process-control-query\n - send-control-notifications\n - update-control-execution-status\n"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.collibra.com/api/references/control-execution/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
