ONonetrust
Issues

Get Attribute Schema

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

get/v1/attributes

Request

  • Base URL
    https://hostname/api/issue-management
  • URL
    https://hostname/api/issue-management/v1/attributes
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ISSUE, ISSUE_READ

Query parameters

schemaName'Issue' required
Example:Issue

The name of the attribute schema.

Response

OK

idstring uuid

The unique identifier of the attribute.

namestring required

The name of the attribute.

nameKeystring

The fallback name of the attribute that is used if a translation is not provided for a language.

descriptionstring

The description of the attribute.

descriptionKeystring

The fallback description of the attribute that is used if a translation is not provided for a language.

fieldNamestring required

The fieldName parameter value of the attribute.

mappedFieldNamestring

The fieldName parameter value of the attribute.

enabledboolean required

This flag indicates whether the attribute is enabled.

requiredboolean

This flag indicates whether the attribute is required.

readOnlyboolean

This flag indicates whether the attribute is read-only.

encryptedboolean

This flag indicates whether the attribute is encrypted.

allowOtherboolean

This flag indicates whether Other can be selected as an option for the attribute value.

baseAttributeboolean

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.

formulastring

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 option.

optionAllowedboolean

This flag indicates whether options were configured for the attribute.

schemaIdstring uuid

The unique identifier of the attribute schema.

schemaNamestring

The name of the attribute schema.

responseMaxLengthinteger

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.

multiSelectMaxOptionValuesinteger

The maximum number of options that can be selected for the attribute.

hiddenboolean

This flag indicates whether the attribute is hidden.

optionUrlstring

The API URL path used to source the attribute option.

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

The status of the attribute marked for deletion.

validationRuleIdstring

The validation rule configured for the attribute.

optionsByDomainobject

The attribute options that are overridden by domain.

formulaByDomainobject

The formula for the attribute, specified by domain.

associatedAttributeFieldNamestring

The fieldName parameter value of the attribute.

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

Changes

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