Sign in
Control Implementations

Search Control Implementation Attributes

Use this API to search for control implementation attributes by key terms and filters.

post/api/controls/v1/control-implementation-attributes/search

Request body

TechRiskComplianceITRiskManagementAttributeQueryCriteria required— unresolved $ref

Response

OK

idstring uuid

Attribute GUID

namestring required

Attribute name

nameKeystring

Attribute name key which can be used for translation

descriptionstring

Attribute description

descriptionKeystring

Attribute description key which can be used for translation

fieldNamestring required

Attribute field name which can be used for uniquely identifying an attribute

mappedFieldNamestring

Mapped Attribute field name. Should be used for sorting

enabledboolean required

Indicator for attribute enabled/disabled

requiredboolean

Indicator for mandatory attribute

readOnlyboolean

Indicator for read only attribute

encryptedboolean

Indicate whether to encrypt the field value or not. Only supported for text, single select and multi select

allowOtherboolean

Indicator for allowing user defined options for attribute

baseAttributeboolean

Indicate if attribute is part of extendable entity and which cannot be modified

responseType'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'Formula' | 'Score' | 'Level' | 'Range'

Response type for attribute

formulastring

Formula for attribute

optionType'None' | 'Static' | 'Dynamic'

Attribute Options value source type

optionAllowedboolean

Indicate if attribute can have static options or not

schemaIdstring uuid

Attribute Schema GUID

schemaNamestring

Attribute Schema Name

responseMaxLengthinteger

Response max length

responseSubType'STANDARD' | 'FORMULA' | 'MATRIX'

Response sub type

multiSelectMaxOptionValuesinteger

MultiSelect max option values

hiddenboolean

Hidden

optionUrlstring

OptionUrl

deleteMarker'MARKED_FOR_DELETE' | 'DELETING' | 'DELETED'

Indicate the status of an attribute's deletion process

validationRuleIdstring

Validation Rule configured for Attribute (e.g., email, URL)

optionsByDomainobject

Override options by Domain

formulaByDomainobject

Formula by Domain

displayResponseType'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'DateTime' | 'NumericalText' | 'NumericalSingleSelect' | 'RadioButton' | 'TextArea' | 'Formula' | 'Level' | 'Range' | 'Score' | 'System'

Display response type for UI - System attributes are displayed as SingleSelect or MultiSelect based on multiSelectMaxOptionValues

associatedAttributeFieldNamestring

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Type of the Record",
    "nameKey": "IM.Name",
    "description": "Gather Type for the record - provide some value related to nature of record",
    "descriptionKey": "IM.Name.Description",
    "fieldName": "nameOfRecord",
    "mappedFieldName": "name",
    "enabled": true,
    "responseType": "Text",
    "formula": "Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)",
    "optionType": "None",
    "schemaId": "550e8400-e29b-41d4-a716-446655440000",
    "schemaName": "vendors",
    "options": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "option": "TypeA",
        "optionKey": "IM.TypeA",
        "colorCode": "#FF5733",
        "sequence": 1,
        "enabled": true
      }
    ],
    "referenceCategories": [
      {
        "name": "Financial Category",
        "nameKey": "IM.FinancialCategoryName"
      }
    ],
    "responseMaxLength": 4000,
    "responseSubType": "STANDARD",
    "associatedAttributeInformation": [
      {
        "name": "Count of members",
        "nameKey": "IM.CountOfMembersName",
        "description": "Provide details about count associated with this attribute",
        "descriptionKey": "IM.CountOfMembersDesc",
        "schemaName": "risk",
        "fieldName": "countOfMembers",
        "mappedFieldName": "count",
        "formula": "sum(1, 3)",
        "options": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "option": "TypeA",
            "optionKey": "IM.TypeA",
            "colorCode": "#FF5733",
            "sequence": 1,
            "enabled": true
          }
        ]
      }
    ],
    "multiSelectMaxOptionValues": 10,
    "optionUrl": "/api/risk-v2/risk-categories",
    "deleteMarker": "MARKED_FOR_DELETE",
    "optionMetadata": {
      "entityTypeName": "Location",
      "basicServiceContextPath": "/api/location",
      "optionUrl": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages",
      "optionListUrl": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details",
      "optionType": "BusinessLocations",
      "applicationUrl": "/settings/location-management/location/Location"
    },
    "validationRuleId": "email",
    "abacBasicAssignmentInfo": [
      {
        "assignmentId": "550e8400-e29b-41d4-a716-446655440000",
        "assignmentName": "Assignment1",
        "policyStatus": "ACTIVE"
      }
    ],
    "displayResponseType": "SingleSelect"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.