v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Issues

Get Attribute Schema

Use this API to retrieve the attribute schema for the specified attribute type.

get/v1/attributes

Query parameters

schemaName'Issue' required

Example:Issue

The name of the attribute schema.

Response

idstring uuid

The unique identifier of the schema attribute.

namestring required

The name of the schema attribute.

nameKeystring

The translation key for schema attribute.

descriptionstring

The description of the schema attribute.

descriptionKeystring

The translation key for schema description.

fieldNamestring required

The field name of the schema attribute.

mappedFieldNamestring

The mapped field name for schema sorting.

enabledboolean required

The enabled flag for schema attribute.

requiredboolean

The required flag for schema attribute.

readOnlyboolean

The read-only flag for schema attribute.

encryptedboolean

The encryption flag for schema attribute.

allowOtherboolean

The user-defined options flag for schema.

baseAttributeboolean

The core entity flag for schema attribute.

The response type for schema attribute.

formulastring

The formula for schema attribute.

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

The option source type for schema.

optionAllowedboolean

The options allowed flag for schema.

schemaIdstring uuid

The schema identifier for attribute.

schemaNamestring

The schema name for attribute.

responseMaxLengthinteger

The max response length for schema.

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

The response subtype for schema.

multiSelectMaxOptionValuesinteger

The maximum multi-select options for schema.

hiddenboolean

The hidden flag for schema attribute.

optionUrlstring

The option URL for schema attribute.

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

The deletion marker for schema attribute.

validationRuleIdstring

The validation rule for schema attribute.

optionsByDomainobject

Override options by Domain

formulaByDomainobject

Formula by Domain

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

associatedAttributeFieldNamestring

The associated field name for schema.

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"
  }
]