--- title: "Disable Attribute" method: PUT path: "/v1/schema-attributes/{attributeId}/disable" tags: ["Object Attribute Management"] --- # Disable Attribute `PUT /v1/schema-attributes/{attributeId}/disable` ## Request - Base URL: `https://hostname/api/custom-entity` - URL: `https://hostname/api/custom-entity/v1/schema-attributes/{attributeId}/disable` - Auth: OAuth 2 - Client credentials - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `OBJECT_MANAGER`, `OBJECT_MANAGER_WRITE` Use this API to disable an attribute. > 🗒 Things to Know > > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets. ## Path parameters - `attributeId` string, uuid, required: ID of the attribute to disable ## Query parameters - `schemaId` string, uuid, required: ID of the schema containing the attribute ## Response `200` OK - AttributeInformation - `id` string, uuid: The unique identifier of the attribute. - `name` string, required: The name of the attribute. - `nameKey` string: The name key of the attribute used for translation purposes. - `description` string: The description of the attribute. - `descriptionKey` string: The description key of the attribute used for translation purposes. - `fieldName` string, required: The fieldName parameter value of the attribute. - `mappedFieldName` string: The mapped attribute field name. - `enabled` boolean, required: This flag indicates whether the attribute is enabled. - `required` boolean: This flag indicates whether the attribute is required. - `readOnly` boolean: This flag indicates whether the attribute is read-only. - `encrypted` boolean: This flag indicates whether the attribute is encrypted. - `allowOther` boolean: This flag indicates whether Other can be selected as an option for the attribute value. - `baseAttribute` boolean: This flag indicates whether the attribute is a system attribute. - `responseType` 'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'Formula' | 'Score' | 'Level' | 'Range': The type of response associated with the attribute value. - `formula` string: The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value. - `optionType` 'None' | 'Static' | 'Dynamic': The type of system list used to source the attribute options. - `optionAllowed` boolean: This flag indicates whether options were configured for the attribute. - `schemaId` string, uuid: The unique identifier of the attribute schema. - `schemaName` string: The name of the attribute schema. - `options` AttributeOptionInformation[]: The options for the attribute. - `id` string, uuid: The unique identifier of the attribute option. - `option` string, required: The name of the attribute option. - `optionKey` string: The name key of the attribute option used for translation purposes. - `colorCode` string: The color code associated with the attribute option. - `sequence` integer: The sequential order in which the attribute option displays. - `enabled` boolean: This flag indicates whether the attribute option is enabled. - `metadata` AttributeOptionMetadata - `hint` string: The hint of the attribute option. - `hintKey` string: The hint key of the attribute option used for translation purposes. - `referenceCategories` CategoryInformation[]: The category details of the attribute. - `id` string, uuid: The unique identifier of the category. - `name` string: The name of the category. - `nameKey` string: The name key of the category used for translation purposes. - `responseMaxLength` integer: The maximum number of characters that can be entered for the attribute value. - `responseSubType` 'STANDARD' | 'FORMULA' | 'MATRIX': The type of scoring method associated with the attribute value. - `associatedAttributeInformation` AssociatedAttributeInformation[]: The details of the associated attributes. - `id` string, uuid, required: The unique identifier of the attribute. - `name` string, required: The name of the attribute. - `nameKey` string: The name key of the attribute used for translation purposes. - `description` string: The description of the attribute. - `descriptionKey` string: The description key of the attribute used for translation purposes. - `schemaId` string, uuid: The unique identifier of the attribute schema. - `schemaName` string: The name of the attribute schema. - `fieldName` string, required: The fieldName parameter value of the attribute. - `mappedFieldName` string: The mapped attribute field name. - `enabled` boolean, required: This flag indicates if the attribute is enabled. - `responseType` 'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'DateTime' | 'NumericalText' | 'NumericalSingleSelect' | 'RadioButton' | 'TextArea' | 'Formula' | 'Level' | 'Range' | 'Score' | 'System', required: The type of response associated with the attribute. - `responseSubType` 'Standard' | 'Formula' | 'Matrix' | 'RollUp': The type of scoring method associated with the attribute. - `formula` string: The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value. - `options` AttributeOptionInformation[]: The options for the attribute. - `id` string, uuid: The unique identifier of the attribute option. - `option` string, required: The name of the attribute option. - `optionKey` string: The name key of the attribute option used for translation purposes. - `colorCode` string: The color code associated with the attribute option. - `sequence` integer: The sequential order in which the attribute option displays. - `enabled` boolean: This flag indicates whether the attribute option is enabled. - `metadata` AttributeOptionMetadata - `hint` string: The hint of the attribute option. - `hintKey` string: The hint key of the attribute option used for translation purposes. - `multiSelectMaxOptionValues` integer: The maximum number of options that can be selected for the attribute. - `hidden` boolean: This flag indicates whether the attribute is hidden. - `optionUrl` string: The URL of the attribute option. - `intakeQuestion` IntakeQuestion - `nameKey` string: The name key of the attribute intake question used for translation purposes. - `name` string: The name of the attribute intake question. - `descriptionKey` string: The description key of the attribute intake question used for translation purposes. - `description` string: The description of the attribute intake question. - `deleteMarker` 'MARKED_FOR_DELETE' | 'DELETING' | 'DELETED': The deletion status of the attribute. - `optionMetadata` AttributeOptionMetadataInformation - `entityTypeName` string: The type of system list used to source the attribute option. - `basicServiceContextPath` string: The base path of the API URL used to source the attribute option. - `optionUrl` string: The API URL path used to source the attribute option. - `viewType` string: The display format of the attribute option. - `validationRuleId` string: The validation rule configured for the attribute. - `associatedAttributeFieldName` string: The fieldName parameter value of the attribute. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview). - `500`: Internal Server Error --- [API](https://skmtc.dev/onetrust/apis/platform-object-manager.md) - [All operations](https://skmtc.dev/onetrust/apis/platform-object-manager/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/platform-object-manager/revisions/76e5833717c3?raw)