> 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-tower/models.md).

# Models

## The ControlList object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlList":{"description":"A list of controls.","type":"object","required":["results"],"properties":{"results":{"description":"List of controls.","type":"array","items":{"$ref":"#/components/schemas/Control"}}}},"Control":{"description":"Schema for a control.","type":"object","properties":{"id":{"$ref":"#/components/schemas/ControlId"},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"category":{"$ref":"#/components/schemas/ControlCategory"},"domainId":{"$ref":"#/components/schemas/ControlDomainId"},"severity":{"$ref":"#/components/schemas/ControlSeverity"},"controlType":{"$ref":"#/components/schemas/ControlType"},"owners":{"allOf":[{"$ref":"#/components/schemas/ControlOwners"}],"description":"The owners of the control. Can be users or user groups."},"enabled":{"$ref":"#/components/schemas/ControlEnabled"},"resolution":{"$ref":"#/components/schemas/Resolution"},"query":{"$ref":"#/components/schemas/ControlQuery"},"queryInvalid":{"description":"Whether the control's query is currently invalid.\n\nThis value is read-only: it reflects the last determination made for this control and cannot be set\ndirectly through this resource.\n","type":"boolean","readOnly":true},"executionSchedule":{"$ref":"#/components/schemas/ControlExecutionSchedule"},"notificationSettings":{"$ref":"#/components/schemas/ControlNotificationSettings"}},"required":["id","name","description","domainId","severity","controlType","owners","enabled","queryInvalid"]},"ControlId":{"description":"The ID of the control asset.","type":"string","format":"uuid"},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000},"ControlCategory":{"description":"The category of the control.","type":"string","maxLength":255},"ControlDomainId":{"description":"The ID of the domain to which the control belongs.","type":"string","format":"uuid"},"ControlSeverity":{"description":"The severity level of the control.\n\nPossible values are `Low`, `Medium`, and `High`.\n","type":"string","maxLength":255},"ControlType":{"description":"The type of control.\n\nPossible values are `Preventative`, `Detective`, `Corrective`, and `Directive`.\n","type":"string","maxLength":255},"ControlOwners":{"description":"The owners of the control. Can be users or user groups. Send an empty array to clear all owners.","type":["array","null"],"maxItems":50,"items":{"$ref":"#/components/schemas/ControlOwner"}},"ControlOwner":{"description":"The owner id of the control. Can be a user or a user group.","type":"string","format":"uuid"},"ControlEnabled":{"description":"If the control is enabled or not.","type":"boolean"},"Resolution":{"description":"Details the specific actions or steps required to address and resolve a control failure.","type":"string","maxLength":2000},"ControlQuery":{"description":"The query that defines the logic for finding non-compliant assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API. Its specification is published on https://developer.collibra.com/, both as an\nOpenAPI document and as a JSON Schema you can validate a query against.","type":"object","additionalProperties":true},"ControlExecutionSchedule":{"description":"The schedule for executing the control.\n\nA control can be executed at different frequencies, such as hourly, daily, or weekly.\n","type":"object","required":["frequency"],"properties":{"frequency":{"description":"How often the control should be executed.\n\nPossible values are:\n- `Hourly`: Executes every hour.\n- `Daily`: Executes every day.\n- `Weekly`: Executes every week.\n","type":"string"},"timeOfDay":{"description":"The time of day when the control execution should start. This is in 24-hour format using the RFC 3339\nfull-time format. The minutes and seconds are ignored and will be set to zero.\n\nFormat: HH:MM:SS[.sss]Z or HH:MM:SS[.sss]±HH:MM\n\nValid examples:\n  * \"14:30:00Z\" (2:30 PM UTC)\n  * \"09:00:00+05:00\" (9:00:00 AM in UTC+5 timezone)\n  * \"23:00:00-08:00\" (11:00:00 PM in UTC-8 timezone)\n  * \"12:00:00.500Z\" (12:00:00.500 PM UTC with milliseconds)\n  * \"18:00:00+02:00\" (6:00:00 PM in UTC+2 timezone)\n\n  Key components:\n  * Time in 24-hour format (HH:MM:SS)\n  * Required timezone offset (Z for UTC, or ±HH:MM for other timezones)\n\nThis property is required if the frequency is set to `Daily` or `Weekly`, and is ignored otherwise.\n","type":"string","format":"time"},"daysOfWeek":{"description":"The days of the week when the control should be executed.\n\nThis property is required if the frequency is set to `Weekly`, and is ignored otherwise. It must contain\nat least one day.\n\nPossible values are:\n- `Monday`\n- `Tuesday`\n- `Wednesday`\n- `Thursday`\n- `Friday`\n- `Saturday`\n- `Sunday`\n","type":"array","maxItems":7,"items":{"type":"string"}}}},"ControlNotificationSettings":{"description":"The notification settings of the control.\n","type":"object","required":["recipients"],"properties":{"message":{"type":"string","description":"The custom message to be used in the notification mail."},"recipients":{"type":"array","description":"The list of notification recipients.","maxItems":50,"items":{"$ref":"#/components/schemas/NotificationRecipient"}}}},"NotificationRecipient":{"description":"The recipient of the control notification.","type":"object","required":["type","id"],"properties":{"type":{"type":"string","description":"Resource type name.\n\nPossible values are `User` and `Role`.\n"},"id":{"type":"string","format":"uuid","description":"The resource id."},"name":{"type":"string","description":"The resource name.","readOnly":true}}}}}}
```

## The ControlId object

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

## The Control object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"Control":{"description":"Schema for a control.","type":"object","properties":{"id":{"$ref":"#/components/schemas/ControlId"},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"category":{"$ref":"#/components/schemas/ControlCategory"},"domainId":{"$ref":"#/components/schemas/ControlDomainId"},"severity":{"$ref":"#/components/schemas/ControlSeverity"},"controlType":{"$ref":"#/components/schemas/ControlType"},"owners":{"allOf":[{"$ref":"#/components/schemas/ControlOwners"}],"description":"The owners of the control. Can be users or user groups."},"enabled":{"$ref":"#/components/schemas/ControlEnabled"},"resolution":{"$ref":"#/components/schemas/Resolution"},"query":{"$ref":"#/components/schemas/ControlQuery"},"queryInvalid":{"description":"Whether the control's query is currently invalid.\n\nThis value is read-only: it reflects the last determination made for this control and cannot be set\ndirectly through this resource.\n","type":"boolean","readOnly":true},"executionSchedule":{"$ref":"#/components/schemas/ControlExecutionSchedule"},"notificationSettings":{"$ref":"#/components/schemas/ControlNotificationSettings"}},"required":["id","name","description","domainId","severity","controlType","owners","enabled","queryInvalid"]},"ControlId":{"description":"The ID of the control asset.","type":"string","format":"uuid"},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000},"ControlCategory":{"description":"The category of the control.","type":"string","maxLength":255},"ControlDomainId":{"description":"The ID of the domain to which the control belongs.","type":"string","format":"uuid"},"ControlSeverity":{"description":"The severity level of the control.\n\nPossible values are `Low`, `Medium`, and `High`.\n","type":"string","maxLength":255},"ControlType":{"description":"The type of control.\n\nPossible values are `Preventative`, `Detective`, `Corrective`, and `Directive`.\n","type":"string","maxLength":255},"ControlOwners":{"description":"The owners of the control. Can be users or user groups. Send an empty array to clear all owners.","type":["array","null"],"maxItems":50,"items":{"$ref":"#/components/schemas/ControlOwner"}},"ControlOwner":{"description":"The owner id of the control. Can be a user or a user group.","type":"string","format":"uuid"},"ControlEnabled":{"description":"If the control is enabled or not.","type":"boolean"},"Resolution":{"description":"Details the specific actions or steps required to address and resolve a control failure.","type":"string","maxLength":2000},"ControlQuery":{"description":"The query that defines the logic for finding non-compliant assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API. Its specification is published on https://developer.collibra.com/, both as an\nOpenAPI document and as a JSON Schema you can validate a query against.","type":"object","additionalProperties":true},"ControlExecutionSchedule":{"description":"The schedule for executing the control.\n\nA control can be executed at different frequencies, such as hourly, daily, or weekly.\n","type":"object","required":["frequency"],"properties":{"frequency":{"description":"How often the control should be executed.\n\nPossible values are:\n- `Hourly`: Executes every hour.\n- `Daily`: Executes every day.\n- `Weekly`: Executes every week.\n","type":"string"},"timeOfDay":{"description":"The time of day when the control execution should start. This is in 24-hour format using the RFC 3339\nfull-time format. The minutes and seconds are ignored and will be set to zero.\n\nFormat: HH:MM:SS[.sss]Z or HH:MM:SS[.sss]±HH:MM\n\nValid examples:\n  * \"14:30:00Z\" (2:30 PM UTC)\n  * \"09:00:00+05:00\" (9:00:00 AM in UTC+5 timezone)\n  * \"23:00:00-08:00\" (11:00:00 PM in UTC-8 timezone)\n  * \"12:00:00.500Z\" (12:00:00.500 PM UTC with milliseconds)\n  * \"18:00:00+02:00\" (6:00:00 PM in UTC+2 timezone)\n\n  Key components:\n  * Time in 24-hour format (HH:MM:SS)\n  * Required timezone offset (Z for UTC, or ±HH:MM for other timezones)\n\nThis property is required if the frequency is set to `Daily` or `Weekly`, and is ignored otherwise.\n","type":"string","format":"time"},"daysOfWeek":{"description":"The days of the week when the control should be executed.\n\nThis property is required if the frequency is set to `Weekly`, and is ignored otherwise. It must contain\nat least one day.\n\nPossible values are:\n- `Monday`\n- `Tuesday`\n- `Wednesday`\n- `Thursday`\n- `Friday`\n- `Saturday`\n- `Sunday`\n","type":"array","maxItems":7,"items":{"type":"string"}}}},"ControlNotificationSettings":{"description":"The notification settings of the control.\n","type":"object","required":["recipients"],"properties":{"message":{"type":"string","description":"The custom message to be used in the notification mail."},"recipients":{"type":"array","description":"The list of notification recipients.","maxItems":50,"items":{"$ref":"#/components/schemas/NotificationRecipient"}}}},"NotificationRecipient":{"description":"The recipient of the control notification.","type":"object","required":["type","id"],"properties":{"type":{"type":"string","description":"Resource type name.\n\nPossible values are `User` and `Role`.\n"},"id":{"type":"string","format":"uuid","description":"The resource id."},"name":{"type":"string","description":"The resource name.","readOnly":true}}}}}}
```

## The UpdateControl object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"UpdateControl":{"type":"object","description":"Schema for updating a control","properties":{"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"category":{"$ref":"#/components/schemas/ControlCategory"},"domainId":{"$ref":"#/components/schemas/ControlDomainId"},"severity":{"$ref":"#/components/schemas/ControlSeverity"},"controlType":{"$ref":"#/components/schemas/ControlType"},"owners":{"$ref":"#/components/schemas/ControlOwners"},"resolution":{"$ref":"#/components/schemas/Resolution"},"query":{"description":"The query that defines the logic for finding\nnon-compliant assets.\n\nMay be null.\n","allOf":[{"$ref":"#/components/schemas/ControlQuery"}]},"executionSchedule":{"$ref":"#/components/schemas/ControlExecutionSchedule"},"notificationSettings":{"$ref":"#/components/schemas/ControlNotificationSettings"}}},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000},"ControlCategory":{"description":"The category of the control.","type":"string","maxLength":255},"ControlDomainId":{"description":"The ID of the domain to which the control belongs.","type":"string","format":"uuid"},"ControlSeverity":{"description":"The severity level of the control.\n\nPossible values are `Low`, `Medium`, and `High`.\n","type":"string","maxLength":255},"ControlType":{"description":"The type of control.\n\nPossible values are `Preventative`, `Detective`, `Corrective`, and `Directive`.\n","type":"string","maxLength":255},"ControlOwners":{"description":"The owners of the control. Can be users or user groups. Send an empty array to clear all owners.","type":["array","null"],"maxItems":50,"items":{"$ref":"#/components/schemas/ControlOwner"}},"ControlOwner":{"description":"The owner id of the control. Can be a user or a user group.","type":"string","format":"uuid"},"Resolution":{"description":"Details the specific actions or steps required to address and resolve a control failure.","type":"string","maxLength":2000},"ControlQuery":{"description":"The query that defines the logic for finding non-compliant assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API. Its specification is published on https://developer.collibra.com/, both as an\nOpenAPI document and as a JSON Schema you can validate a query against.","type":"object","additionalProperties":true},"ControlExecutionSchedule":{"description":"The schedule for executing the control.\n\nA control can be executed at different frequencies, such as hourly, daily, or weekly.\n","type":"object","required":["frequency"],"properties":{"frequency":{"description":"How often the control should be executed.\n\nPossible values are:\n- `Hourly`: Executes every hour.\n- `Daily`: Executes every day.\n- `Weekly`: Executes every week.\n","type":"string"},"timeOfDay":{"description":"The time of day when the control execution should start. This is in 24-hour format using the RFC 3339\nfull-time format. The minutes and seconds are ignored and will be set to zero.\n\nFormat: HH:MM:SS[.sss]Z or HH:MM:SS[.sss]±HH:MM\n\nValid examples:\n  * \"14:30:00Z\" (2:30 PM UTC)\n  * \"09:00:00+05:00\" (9:00:00 AM in UTC+5 timezone)\n  * \"23:00:00-08:00\" (11:00:00 PM in UTC-8 timezone)\n  * \"12:00:00.500Z\" (12:00:00.500 PM UTC with milliseconds)\n  * \"18:00:00+02:00\" (6:00:00 PM in UTC+2 timezone)\n\n  Key components:\n  * Time in 24-hour format (HH:MM:SS)\n  * Required timezone offset (Z for UTC, or ±HH:MM for other timezones)\n\nThis property is required if the frequency is set to `Daily` or `Weekly`, and is ignored otherwise.\n","type":"string","format":"time"},"daysOfWeek":{"description":"The days of the week when the control should be executed.\n\nThis property is required if the frequency is set to `Weekly`, and is ignored otherwise. It must contain\nat least one day.\n\nPossible values are:\n- `Monday`\n- `Tuesday`\n- `Wednesday`\n- `Thursday`\n- `Friday`\n- `Saturday`\n- `Sunday`\n","type":"array","maxItems":7,"items":{"type":"string"}}}},"ControlNotificationSettings":{"description":"The notification settings of the control.\n","type":"object","required":["recipients"],"properties":{"message":{"type":"string","description":"The custom message to be used in the notification mail."},"recipients":{"type":"array","description":"The list of notification recipients.","maxItems":50,"items":{"$ref":"#/components/schemas/NotificationRecipient"}}}},"NotificationRecipient":{"description":"The recipient of the control notification.","type":"object","required":["type","id"],"properties":{"type":{"type":"string","description":"Resource type name.\n\nPossible values are `User` and `Role`.\n"},"id":{"type":"string","format":"uuid","description":"The resource id."},"name":{"type":"string","description":"The resource name.","readOnly":true}}}}}}
```

## The ControlRequirements object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlRequirements":{"type":"array","description":"An array of requirements.\n","items":{"$ref":"#/components/schemas/ControlRequirement"}},"ControlRequirement":{"type":"object","description":"A requirement defined by the query of a given `Control`.\n\nA requirement is composed of:\n - An `id`, which identifies the filter within a specific query.\n - A `targetType`, which defines the type of the assets filtered by the filter.\n - The `filter` marked as a requirement inside the query of the `Control`\n","properties":{"id":{"$ref":"#/components/schemas/ControlRequirementId"},"targetType":{"$ref":"#/components/schemas/AssetType"},"filter":{"$ref":"#/components/schemas/AssetFilter"}}},"ControlRequirementId":{"type":"string","minLength":17,"maxLength":17,"description":"The ID of a requirement is a 17 characters string that combines the `versionHash` of the parent `ControlQuery`\nwith the `versionHash` of the `AssetFilter` marked as a requirement.\n\nThe 2 hashes are separated by a `-` character.\n\nFor example:\n  - If the `versionHash` of the `ControlQuery` is `ba7816bf`\n  - If the `versionHash` of the `Filter` is `cd294a01`\n  - The identifier of the requirement is `ba7816bf-cd294a01`\n"},"AssetType":{"description":"An asset type or asset type group resource.\n","allOf":[{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/AssetTypeResourceType"},"symbolData":{"$ref":"#/components/schemas/SymbolData"}}},{"$ref":"#/components/schemas/OperatingModelResource"}]},"AssetTypeResourceType":{"type":"string","description":"The type of asset type (asset type or asset type group).\n\nThe possible values are:\n- `AssetType`\n- `AssetTypeGroup`\n","default":"AssetType"},"SymbolData":{"description":"The symbol data of the type.","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/SymbolDataType"}},"type":"object"},"SymbolDataType":{"enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"},"OperatingModelResource":{"type":"object","description":"A resource of the Operating Model.\nThose resources are identified by their public ID.\n","required":["publicId"],"properties":{"publicId":{"type":"string","description":"The public ID of the operating model resource."},"name":{"type":"string","description":"The name of the operating model resource.\n\nFor a relation type:\n- If the direction is `to_target`, the value is the `role` of the relation type.\n- If the direction is `to_source`, the value is the `co-role` of the inverse relation type.\n"}}},"AssetFilter":{"description":"A filter applied to candidate assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API and published on https://developer.collibra.com/.","type":"object","additionalProperties":true}}}}
```

## The ControlRequirement object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlRequirement":{"type":"object","description":"A requirement defined by the query of a given `Control`.\n\nA requirement is composed of:\n - An `id`, which identifies the filter within a specific query.\n - A `targetType`, which defines the type of the assets filtered by the filter.\n - The `filter` marked as a requirement inside the query of the `Control`\n","properties":{"id":{"$ref":"#/components/schemas/ControlRequirementId"},"targetType":{"$ref":"#/components/schemas/AssetType"},"filter":{"$ref":"#/components/schemas/AssetFilter"}}},"ControlRequirementId":{"type":"string","minLength":17,"maxLength":17,"description":"The ID of a requirement is a 17 characters string that combines the `versionHash` of the parent `ControlQuery`\nwith the `versionHash` of the `AssetFilter` marked as a requirement.\n\nThe 2 hashes are separated by a `-` character.\n\nFor example:\n  - If the `versionHash` of the `ControlQuery` is `ba7816bf`\n  - If the `versionHash` of the `Filter` is `cd294a01`\n  - The identifier of the requirement is `ba7816bf-cd294a01`\n"},"AssetType":{"description":"An asset type or asset type group resource.\n","allOf":[{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/AssetTypeResourceType"},"symbolData":{"$ref":"#/components/schemas/SymbolData"}}},{"$ref":"#/components/schemas/OperatingModelResource"}]},"AssetTypeResourceType":{"type":"string","description":"The type of asset type (asset type or asset type group).\n\nThe possible values are:\n- `AssetType`\n- `AssetTypeGroup`\n","default":"AssetType"},"SymbolData":{"description":"The symbol data of the type.","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/SymbolDataType"}},"type":"object"},"SymbolDataType":{"enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"},"OperatingModelResource":{"type":"object","description":"A resource of the Operating Model.\nThose resources are identified by their public ID.\n","required":["publicId"],"properties":{"publicId":{"type":"string","description":"The public ID of the operating model resource."},"name":{"type":"string","description":"The name of the operating model resource.\n\nFor a relation type:\n- If the direction is `to_target`, the value is the `role` of the relation type.\n- If the direction is `to_source`, the value is the `co-role` of the inverse relation type.\n"}}},"AssetFilter":{"description":"A filter applied to candidate assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API and published on https://developer.collibra.com/.","type":"object","additionalProperties":true}}}}
```

## The ControlRequirementId object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlRequirementId":{"type":"string","minLength":17,"maxLength":17,"description":"The ID of a requirement is a 17 characters string that combines the `versionHash` of the parent `ControlQuery`\nwith the `versionHash` of the `AssetFilter` marked as a requirement.\n\nThe 2 hashes are separated by a `-` character.\n\nFor example:\n  - If the `versionHash` of the `ControlQuery` is `ba7816bf`\n  - If the `versionHash` of the `Filter` is `cd294a01`\n  - The identifier of the requirement is `ba7816bf-cd294a01`\n"}}}}
```

## The ControlExecutionSchedule object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlExecutionSchedule":{"description":"The schedule for executing the control.\n\nA control can be executed at different frequencies, such as hourly, daily, or weekly.\n","type":"object","required":["frequency"],"properties":{"frequency":{"description":"How often the control should be executed.\n\nPossible values are:\n- `Hourly`: Executes every hour.\n- `Daily`: Executes every day.\n- `Weekly`: Executes every week.\n","type":"string"},"timeOfDay":{"description":"The time of day when the control execution should start. This is in 24-hour format using the RFC 3339\nfull-time format. The minutes and seconds are ignored and will be set to zero.\n\nFormat: HH:MM:SS[.sss]Z or HH:MM:SS[.sss]±HH:MM\n\nValid examples:\n  * \"14:30:00Z\" (2:30 PM UTC)\n  * \"09:00:00+05:00\" (9:00:00 AM in UTC+5 timezone)\n  * \"23:00:00-08:00\" (11:00:00 PM in UTC-8 timezone)\n  * \"12:00:00.500Z\" (12:00:00.500 PM UTC with milliseconds)\n  * \"18:00:00+02:00\" (6:00:00 PM in UTC+2 timezone)\n\n  Key components:\n  * Time in 24-hour format (HH:MM:SS)\n  * Required timezone offset (Z for UTC, or ±HH:MM for other timezones)\n\nThis property is required if the frequency is set to `Daily` or `Weekly`, and is ignored otherwise.\n","type":"string","format":"time"},"daysOfWeek":{"description":"The days of the week when the control should be executed.\n\nThis property is required if the frequency is set to `Weekly`, and is ignored otherwise. It must contain\nat least one day.\n\nPossible values are:\n- `Monday`\n- `Tuesday`\n- `Wednesday`\n- `Thursday`\n- `Friday`\n- `Saturday`\n- `Sunday`\n","type":"array","maxItems":7,"items":{"type":"string"}}}}}}}
```

## The ControlNotificationSettings object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlNotificationSettings":{"description":"The notification settings of the control.\n","type":"object","required":["recipients"],"properties":{"message":{"type":"string","description":"The custom message to be used in the notification mail."},"recipients":{"type":"array","description":"The list of notification recipients.","maxItems":50,"items":{"$ref":"#/components/schemas/NotificationRecipient"}}}},"NotificationRecipient":{"description":"The recipient of the control notification.","type":"object","required":["type","id"],"properties":{"type":{"type":"string","description":"Resource type name.\n\nPossible values are `User` and `Role`.\n"},"id":{"type":"string","format":"uuid","description":"The resource id."},"name":{"type":"string","description":"The resource name.","readOnly":true}}}}}}
```

## The NotificationRecipient object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"NotificationRecipient":{"description":"The recipient of the control notification.","type":"object","required":["type","id"],"properties":{"type":{"type":"string","description":"Resource type name.\n\nPossible values are `User` and `Role`.\n"},"id":{"type":"string","format":"uuid","description":"The resource id."},"name":{"type":"string","description":"The resource name.","readOnly":true}}}}}}
```

## The ControlOwner object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlOwner":{"description":"The owner id of the control. Can be a user or a user group.","type":"string","format":"uuid"}}}}
```

## The ControlOwners object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlOwners":{"description":"The owners of the control. Can be users or user groups. Send an empty array to clear all owners.","type":["array","null"],"maxItems":50,"items":{"$ref":"#/components/schemas/ControlOwner"}},"ControlOwner":{"description":"The owner id of the control. Can be a user or a user group.","type":"string","format":"uuid"}}}}
```

## The ControlEnabled object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlEnabled":{"description":"If the control is enabled or not.","type":"boolean"}}}}
```

## The ControlName object

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

## The ControlDescription object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000}}}}
```

## The ControlCategory object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlCategory":{"description":"The category of the control.","type":"string","maxLength":255}}}}
```

## The ControlDomainId object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlDomainId":{"description":"The ID of the domain to which the control belongs.","type":"string","format":"uuid"}}}}
```

## The ControlSeverity object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlSeverity":{"description":"The severity level of the control.\n\nPossible values are `Low`, `Medium`, and `High`.\n","type":"string","maxLength":255}}}}
```

## The ControlType object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlType":{"description":"The type of control.\n\nPossible values are `Preventative`, `Detective`, `Corrective`, and `Directive`.\n","type":"string","maxLength":255}}}}
```

## The Resolution object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"Resolution":{"description":"Details the specific actions or steps required to address and resolve a control failure.","type":"string","maxLength":2000}}}}
```

## The CreateControl object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"CreateControl":{"description":"Schema for creating a new control.","type":"object","properties":{"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"category":{"$ref":"#/components/schemas/ControlCategory"},"domainId":{"$ref":"#/components/schemas/ControlDomainId"},"owners":{"$ref":"#/components/schemas/ControlOwners"},"severity":{"$ref":"#/components/schemas/ControlSeverity"},"controlType":{"$ref":"#/components/schemas/ControlType"},"resolution":{"$ref":"#/components/schemas/Resolution"},"executionSchedule":{"$ref":"#/components/schemas/ControlExecutionSchedule"},"query":{"description":"The query that defines the logic for finding\nnon-compliant assets.\n\nMay be null.\n","allOf":[{"$ref":"#/components/schemas/ControlQuery"}]},"notificationSettings":{"$ref":"#/components/schemas/ControlNotificationSettings"}},"required":["name","domainId","severity"]},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000},"ControlCategory":{"description":"The category of the control.","type":"string","maxLength":255},"ControlDomainId":{"description":"The ID of the domain to which the control belongs.","type":"string","format":"uuid"},"ControlOwners":{"description":"The owners of the control. Can be users or user groups. Send an empty array to clear all owners.","type":["array","null"],"maxItems":50,"items":{"$ref":"#/components/schemas/ControlOwner"}},"ControlOwner":{"description":"The owner id of the control. Can be a user or a user group.","type":"string","format":"uuid"},"ControlSeverity":{"description":"The severity level of the control.\n\nPossible values are `Low`, `Medium`, and `High`.\n","type":"string","maxLength":255},"ControlType":{"description":"The type of control.\n\nPossible values are `Preventative`, `Detective`, `Corrective`, and `Directive`.\n","type":"string","maxLength":255},"Resolution":{"description":"Details the specific actions or steps required to address and resolve a control failure.","type":"string","maxLength":2000},"ControlExecutionSchedule":{"description":"The schedule for executing the control.\n\nA control can be executed at different frequencies, such as hourly, daily, or weekly.\n","type":"object","required":["frequency"],"properties":{"frequency":{"description":"How often the control should be executed.\n\nPossible values are:\n- `Hourly`: Executes every hour.\n- `Daily`: Executes every day.\n- `Weekly`: Executes every week.\n","type":"string"},"timeOfDay":{"description":"The time of day when the control execution should start. This is in 24-hour format using the RFC 3339\nfull-time format. The minutes and seconds are ignored and will be set to zero.\n\nFormat: HH:MM:SS[.sss]Z or HH:MM:SS[.sss]±HH:MM\n\nValid examples:\n  * \"14:30:00Z\" (2:30 PM UTC)\n  * \"09:00:00+05:00\" (9:00:00 AM in UTC+5 timezone)\n  * \"23:00:00-08:00\" (11:00:00 PM in UTC-8 timezone)\n  * \"12:00:00.500Z\" (12:00:00.500 PM UTC with milliseconds)\n  * \"18:00:00+02:00\" (6:00:00 PM in UTC+2 timezone)\n\n  Key components:\n  * Time in 24-hour format (HH:MM:SS)\n  * Required timezone offset (Z for UTC, or ±HH:MM for other timezones)\n\nThis property is required if the frequency is set to `Daily` or `Weekly`, and is ignored otherwise.\n","type":"string","format":"time"},"daysOfWeek":{"description":"The days of the week when the control should be executed.\n\nThis property is required if the frequency is set to `Weekly`, and is ignored otherwise. It must contain\nat least one day.\n\nPossible values are:\n- `Monday`\n- `Tuesday`\n- `Wednesday`\n- `Thursday`\n- `Friday`\n- `Saturday`\n- `Sunday`\n","type":"array","maxItems":7,"items":{"type":"string"}}}},"ControlQuery":{"description":"The query that defines the logic for finding non-compliant assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API. Its specification is published on https://developer.collibra.com/, both as an\nOpenAPI document and as a JSON Schema you can validate a query against.","type":"object","additionalProperties":true},"ControlNotificationSettings":{"description":"The notification settings of the control.\n","type":"object","required":["recipients"],"properties":{"message":{"type":"string","description":"The custom message to be used in the notification mail."},"recipients":{"type":"array","description":"The list of notification recipients.","maxItems":50,"items":{"$ref":"#/components/schemas/NotificationRecipient"}}}},"NotificationRecipient":{"description":"The recipient of the control notification.","type":"object","required":["type","id"],"properties":{"type":{"type":"string","description":"Resource type name.\n\nPossible values are `User` and `Role`.\n"},"id":{"type":"string","format":"uuid","description":"The resource id."},"name":{"type":"string","description":"The resource name.","readOnly":true}}}}}}
```

## The ControlCreated object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlCreated":{"description":"Response schema for a successfully created control.","type":"object","properties":{"id":{"description":"The unique identifier of the created control.","type":"string","format":"uuid"}},"required":["id"]}}}}
```

## The ControlQuery object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ControlQuery":{"description":"The query that defines the logic for finding non-compliant assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API. Its specification is published on https://developer.collibra.com/, both as an\nOpenAPI document and as a JSON Schema you can validate a query against.","type":"object","additionalProperties":true}}}}
```

## The AssetFilter object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"AssetFilter":{"description":"A filter applied to candidate assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API and published on https://developer.collibra.com/.","type":"object","additionalProperties":true}}}}
```

## The OperatingModelResource object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"OperatingModelResource":{"type":"object","description":"A resource of the Operating Model.\nThose resources are identified by their public ID.\n","required":["publicId"],"properties":{"publicId":{"type":"string","description":"The public ID of the operating model resource."},"name":{"type":"string","description":"The name of the operating model resource.\n\nFor a relation type:\n- If the direction is `to_target`, the value is the `role` of the relation type.\n- If the direction is `to_source`, the value is the `co-role` of the inverse relation type.\n"}}}}}}
```

## The AssetTypeResourceType object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"AssetTypeResourceType":{"type":"string","description":"The type of asset type (asset type or asset type group).\n\nThe possible values are:\n- `AssetType`\n- `AssetTypeGroup`\n","default":"AssetType"}}}}
```

## The AssetType object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"AssetType":{"description":"An asset type or asset type group resource.\n","allOf":[{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/AssetTypeResourceType"},"symbolData":{"$ref":"#/components/schemas/SymbolData"}}},{"$ref":"#/components/schemas/OperatingModelResource"}]},"AssetTypeResourceType":{"type":"string","description":"The type of asset type (asset type or asset type group).\n\nThe possible values are:\n- `AssetType`\n- `AssetTypeGroup`\n","default":"AssetType"},"SymbolData":{"description":"The symbol data of the type.","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/SymbolDataType"}},"type":"object"},"SymbolDataType":{"enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"},"OperatingModelResource":{"type":"object","description":"A resource of the Operating Model.\nThose resources are identified by their public ID.\n","required":["publicId"],"properties":{"publicId":{"type":"string","description":"The public ID of the operating model resource."},"name":{"type":"string","description":"The name of the operating model resource.\n\nFor a relation type:\n- If the direction is `to_target`, the value is the `role` of the relation type.\n- If the direction is `to_source`, the value is the `co-role` of the inverse relation type.\n"}}}}}}
```

## The SymbolData object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"SymbolData":{"description":"The symbol data of the type.","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/SymbolDataType"}},"type":"object"},"SymbolDataType":{"enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"}}}}
```

## The SymbolDataType object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"SymbolDataType":{"enum":["NONE","ICON_CODE","ACRONYM_CODE"],"type":"string"}}}}
```

## The OotbControlSummary object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"OotbControlSummary":{"description":"Summary representation of an OOTB Control, including its import status relative to this instance.","type":"object","required":["publicId","category","name","description","importStatus"],"properties":{"publicId":{"type":"string","description":"Human-readable identifier for the OOTB Control. Uses PascalCase with no spaces or special characters."},"assetId":{"type":"string","format":"uuid","description":"The ID of the Managed `Control` asset in the `Knowledge Graph` that was created when this OOTB Control was imported. Only present if the OOTB Control has been imported before (i.e. `importStatus` is not `NEW`)."},"category":{"$ref":"#/components/schemas/ControlCategory"},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"importStatus":{"type":"string","description":"The import status of the OOTB Control relative to this tenant. Determined by comparing the OOTB Control with the Managed Control currently defined.  Possible values:\n- `NEW`: The OOTB Control has not been imported\n  into this tenant yet. No corresponding Managed\n  Control exists.\n\n- `EXISTS_NOT_CHANGED`: A Managed Control was\n  previously created from this OOTB Control and\n  the template has not changed since (version\n  hashes match).\n\n- `EXISTS_CHANGED`: A Managed Control was\n  previously created from this OOTB Control but\n  the template has been updated since (version\n  hashes differ). The user may want to re-import\n  to pick up the latest changes.\n\nThis is not an enum because new values may be added in the future."},"importStatusDetails":{"$ref":"#/components/schemas/ImportStatusDetails"}}},"ControlCategory":{"description":"The category of the control.","type":"string","maxLength":255},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000},"ImportStatusDetails":{"description":"Per-field comparison between an OOTB Control and the Managed Control previously imported from it.\nThis object is **optional**. It is only returned when **both** of the following are true:\n  - the OOTB Control identified by `publicId` exists in this\n    system (i.e. a Managed Control was previously imported\n    from it), AND\n  - at least one match flag is `false` (i.e. the Managed\n    Control diverges from the current OOTB Control template\n    on at least one field).\n\nWhen omitted, callers should interpret it as \"no divergence worth reporting\": either the OOTB Control was never imported here, or every comparable field still matches the template. This lets the UI highlight exactly which fields would be overwritten on a re-import.\nEach individual flag is also optional. An omitted flag means the comparison was not evaluated for that field (typically because an exception short-circuited the check) and should be treated as \"unknown\", not as a match.","type":"object","properties":{"nameMatches":{"description":"Whether the `name` of the Managed Control matches the OOTB Control's `name`.","type":"boolean"},"descriptionMatches":{"description":"Whether the `description` of the Managed Control matches the OOTB Control's `description`.","type":"boolean"},"severityMatches":{"description":"Whether the `severity` of the Managed Control matches the OOTB Control's `severity`.","type":"boolean"},"controlTypeMatches":{"description":"Whether the `controlType` of the Managed Control matches the OOTB Control's `controlType`.","type":"boolean"},"categoryMatches":{"description":"Whether the `category` of the Managed Control matches the OOTB Control's `category`.","type":"boolean"},"queryMatches":{"description":"Whether the `query` of the Managed Control matches the OOTB Control's `query`.","type":"boolean"},"executionScheduleMatches":{"description":"Whether the `executionSchedule` of the Managed Control matches the OOTB Control's `executionSchedule`.","type":"boolean"},"notificationSettingsMatches":{"description":"Whether the `notificationSettings` of the Managed Control matches the OOTB Control's `notificationSettings`.","type":"boolean"}}}}}}
```

## The ImportStatusDetails object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ImportStatusDetails":{"description":"Per-field comparison between an OOTB Control and the Managed Control previously imported from it.\nThis object is **optional**. It is only returned when **both** of the following are true:\n  - the OOTB Control identified by `publicId` exists in this\n    system (i.e. a Managed Control was previously imported\n    from it), AND\n  - at least one match flag is `false` (i.e. the Managed\n    Control diverges from the current OOTB Control template\n    on at least one field).\n\nWhen omitted, callers should interpret it as \"no divergence worth reporting\": either the OOTB Control was never imported here, or every comparable field still matches the template. This lets the UI highlight exactly which fields would be overwritten on a re-import.\nEach individual flag is also optional. An omitted flag means the comparison was not evaluated for that field (typically because an exception short-circuited the check) and should be treated as \"unknown\", not as a match.","type":"object","properties":{"nameMatches":{"description":"Whether the `name` of the Managed Control matches the OOTB Control's `name`.","type":"boolean"},"descriptionMatches":{"description":"Whether the `description` of the Managed Control matches the OOTB Control's `description`.","type":"boolean"},"severityMatches":{"description":"Whether the `severity` of the Managed Control matches the OOTB Control's `severity`.","type":"boolean"},"controlTypeMatches":{"description":"Whether the `controlType` of the Managed Control matches the OOTB Control's `controlType`.","type":"boolean"},"categoryMatches":{"description":"Whether the `category` of the Managed Control matches the OOTB Control's `category`.","type":"boolean"},"queryMatches":{"description":"Whether the `query` of the Managed Control matches the OOTB Control's `query`.","type":"boolean"},"executionScheduleMatches":{"description":"Whether the `executionSchedule` of the Managed Control matches the OOTB Control's `executionSchedule`.","type":"boolean"},"notificationSettingsMatches":{"description":"Whether the `notificationSettings` of the Managed Control matches the OOTB Control's `notificationSettings`.","type":"boolean"}}}}}}
```

## The OotbControlList object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"OotbControlList":{"description":"Response containing the list of available OOTB Controls.","type":"object","required":["results"],"properties":{"results":{"description":"List of OOTB Controls.","type":"array","items":{"$ref":"#/components/schemas/OotbControlSummary"}}}},"OotbControlSummary":{"description":"Summary representation of an OOTB Control, including its import status relative to this instance.","type":"object","required":["publicId","category","name","description","importStatus"],"properties":{"publicId":{"type":"string","description":"Human-readable identifier for the OOTB Control. Uses PascalCase with no spaces or special characters."},"assetId":{"type":"string","format":"uuid","description":"The ID of the Managed `Control` asset in the `Knowledge Graph` that was created when this OOTB Control was imported. Only present if the OOTB Control has been imported before (i.e. `importStatus` is not `NEW`)."},"category":{"$ref":"#/components/schemas/ControlCategory"},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"importStatus":{"type":"string","description":"The import status of the OOTB Control relative to this tenant. Determined by comparing the OOTB Control with the Managed Control currently defined.  Possible values:\n- `NEW`: The OOTB Control has not been imported\n  into this tenant yet. No corresponding Managed\n  Control exists.\n\n- `EXISTS_NOT_CHANGED`: A Managed Control was\n  previously created from this OOTB Control and\n  the template has not changed since (version\n  hashes match).\n\n- `EXISTS_CHANGED`: A Managed Control was\n  previously created from this OOTB Control but\n  the template has been updated since (version\n  hashes differ). The user may want to re-import\n  to pick up the latest changes.\n\nThis is not an enum because new values may be added in the future."},"importStatusDetails":{"$ref":"#/components/schemas/ImportStatusDetails"}}},"ControlCategory":{"description":"The category of the control.","type":"string","maxLength":255},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000},"ImportStatusDetails":{"description":"Per-field comparison between an OOTB Control and the Managed Control previously imported from it.\nThis object is **optional**. It is only returned when **both** of the following are true:\n  - the OOTB Control identified by `publicId` exists in this\n    system (i.e. a Managed Control was previously imported\n    from it), AND\n  - at least one match flag is `false` (i.e. the Managed\n    Control diverges from the current OOTB Control template\n    on at least one field).\n\nWhen omitted, callers should interpret it as \"no divergence worth reporting\": either the OOTB Control was never imported here, or every comparable field still matches the template. This lets the UI highlight exactly which fields would be overwritten on a re-import.\nEach individual flag is also optional. An omitted flag means the comparison was not evaluated for that field (typically because an exception short-circuited the check) and should be treated as \"unknown\", not as a match.","type":"object","properties":{"nameMatches":{"description":"Whether the `name` of the Managed Control matches the OOTB Control's `name`.","type":"boolean"},"descriptionMatches":{"description":"Whether the `description` of the Managed Control matches the OOTB Control's `description`.","type":"boolean"},"severityMatches":{"description":"Whether the `severity` of the Managed Control matches the OOTB Control's `severity`.","type":"boolean"},"controlTypeMatches":{"description":"Whether the `controlType` of the Managed Control matches the OOTB Control's `controlType`.","type":"boolean"},"categoryMatches":{"description":"Whether the `category` of the Managed Control matches the OOTB Control's `category`.","type":"boolean"},"queryMatches":{"description":"Whether the `query` of the Managed Control matches the OOTB Control's `query`.","type":"boolean"},"executionScheduleMatches":{"description":"Whether the `executionSchedule` of the Managed Control matches the OOTB Control's `executionSchedule`.","type":"boolean"},"notificationSettingsMatches":{"description":"Whether the `notificationSettings` of the Managed Control matches the OOTB Control's `notificationSettings`.","type":"boolean"}}}}}}
```

## The ImportOotbControls object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ImportOotbControls":{"description":"Request to import one or more OOTB Controls into this instance as Managed Controls.","type":"object","required":["publicIds"],"properties":{"publicIds":{"description":"List of OOTB Control public IDs to import.","type":"array","minItems":1,"maxItems":500,"items":{"type":"string","maxLength":255}}}}}}}
```

## The ImportOotbControlResult object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ImportOotbControlResult":{"description":"The outcome of importing a single OOTB Control.","type":"object","required":["publicId","outcome"],"properties":{"publicId":{"type":"string","description":"The public identifier of the requested OOTB Control."},"assetId":{"type":"string","format":"uuid","description":"The ID of the relevant Managed Control. Present for `ADDED`, `UPDATED`, and `IGNORED` outcomes, and for `FAILED` re-imports of an existing Managed Control. Absent for `FAILED` creations (nothing was created) and for `NOT_FOUND`."},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"outcome":{"type":"string","description":"The outcome of the import operation for this OOTB Control. Possible values:\n- `ADDED`: The OOTB Control was successfully imported\n  as a new Managed Control.\n\n- `UPDATED`: A Managed Control previously created from\n  this OOTB Control was updated with the latest template.\n\n- `IGNORED`: The OOTB Control was already imported and\n  unchanged. No action was taken.\n\n- `FAILED`: The import failed. See `errorMessage` for\n  details.\n\n- `NOT_FOUND`: no OOTB Control with this `publicId`\n  exists upstream. See `errorMessage` for details. No\n  action was taken.\n\nThis is not an enum because new values may be added in the future."},"errorMessage":{"type":"string","description":"Error details. Present when the outcome is `FAILED` or `NOT_FOUND`."}}},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000}}}}
```

## The ImportOotbControlsResult object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"ImportOotbControlsResult":{"description":"Response for importing OOTB Controls. Includes per-control outcomes.","type":"object","required":["results"],"properties":{"results":{"description":"Per-control import outcomes.","type":"array","items":{"$ref":"#/components/schemas/ImportOotbControlResult"}}}},"ImportOotbControlResult":{"description":"The outcome of importing a single OOTB Control.","type":"object","required":["publicId","outcome"],"properties":{"publicId":{"type":"string","description":"The public identifier of the requested OOTB Control."},"assetId":{"type":"string","format":"uuid","description":"The ID of the relevant Managed Control. Present for `ADDED`, `UPDATED`, and `IGNORED` outcomes, and for `FAILED` re-imports of an existing Managed Control. Absent for `FAILED` creations (nothing was created) and for `NOT_FOUND`."},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"outcome":{"type":"string","description":"The outcome of the import operation for this OOTB Control. Possible values:\n- `ADDED`: The OOTB Control was successfully imported\n  as a new Managed Control.\n\n- `UPDATED`: A Managed Control previously created from\n  this OOTB Control was updated with the latest template.\n\n- `IGNORED`: The OOTB Control was already imported and\n  unchanged. No action was taken.\n\n- `FAILED`: The import failed. See `errorMessage` for\n  details.\n\n- `NOT_FOUND`: no OOTB Control with this `publicId`\n  exists upstream. See `errorMessage` for details. No\n  action was taken.\n\nThis is not an enum because new values may be added in the future."},"errorMessage":{"type":"string","description":"Error details. Present when the outcome is `FAILED` or `NOT_FOUND`."}}},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000}}}}
```

## The StandardErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"components":{"schemas":{"StandardErrorResponse":{"description":"A standard error response object.","type":"object","properties":{"statusCode":{"description":"HTTP response code.","type":"integer"},"titleMessage":{"description":"The title of the error message.","type":"string"},"helpMessage":{"description":"A message containing actions you can take regarding the error.","type":"string"},"userMessage":{"description":"A user friendly error message.","type":"string"},"errorCode":{"description":"An error code identifier.","type":"string"},"query":{"description":"The rejected control query, with each issue attached to the part of the query it applies to\nand `isValid` set to `false`.\n\nOnly present when the request was refused because of its query.\n","allOf":[{"$ref":"#/components/schemas/ControlQuery"}]}},"required":["statusCode","errorCode","userMessage"]},"ControlQuery":{"description":"The query that defines the logic for finding non-compliant assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API. Its specification is published on https://developer.collibra.com/, both as an\nOpenAPI document and as a JSON Schema you can validate a query against.","type":"object","additionalProperties":true}}}}
```


---

# 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-tower/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.
