Get Attribute Schema

get https://{hostname}/api/issue-management/v1/attributes

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

Responses

Response body

array of objects

object

uuid

The unique identifier of the attribute.

name

string

required

The name of the attribute.

nameKey

string

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

description

string

The description of the attribute.

descriptionKey

string

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

fieldName

string

required

The fieldName parameter value of the attribute.

mappedFieldName

string

The fieldName parameter value of the attribute.

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

string

The type of response associated with the attribute value.

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

formula

string

The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value.

optionType

string

The type of system list used to source the attribute option.

optionAllowed

boolean

This flag indicates whether options were configured for the attribute.

schemaId

uuid

The unique identifier of the attribute schema.

schemaName

string

The name of the attribute schema.

options

array of objects

The details of the attribute options.

options

object

uuid

The unique identifier of the attribute option.

option

string

required

The name of the attribute option.

optionKey

string

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

colorCode

string

The color code associated with the attribute option.

sequence

int32

The sequential order in which the attribute options display.

enabled

boolean

This flag indicates whether the attribute option is enabled.

metadata

object

The metadata of the attribute option.

referenceCategories

array of objects

The category details of the attribute.

referenceCategories

object

uuid

The unique identifier of the category.

name

string

The name of the category.

nameKey

string

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

responseMaxLength

int32

The maximum number of characters that can be entered for the attribute value.

responseSubType

string

The type of scoring method associated with the attribute value.

Standard Formula Matrix RollUp

associatedAttributeInformation

array of objects

The details of the attribute.

associatedAttributeInformation

object

uuid

required

The unique identifier of the attribute.

name

string

required

The name of the attribute.

nameKey

string

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

description

string

The description of the attribute.

descriptionKey

string

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

schemaId

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 fieldName parameter value of the attribute.

enabled

boolean

required

This flag indicates if the attribute is enabled.

responseType

string

required

The type of response associated with the attribute.

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

responseSubType

string

The type of scoring method associated with the attribute.

Standard Formula Matrix RollUp

formula

string

The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value.

options

array of objects

The options for the attribute.

options

object

uuid

The unique identifier of the attribute option.

option

string

required

The name of the attribute option.

optionKey

string

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

colorCode

string

The color code associated with the attribute option.

sequence

int32

The sequential order in which the attribute options display.

enabled

boolean

This flag indicates whether the attribute option is enabled.

metadata

object

The metadata of the attribute option.

multiSelectMaxOptionValues

int32

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 API URL path used to source the attribute option.

intakeQuestion

object

The details of the assessment question for which the issue was flagged.

deleteMarker

string

The status of the attribute marked for deletion.

PENDING IN_PROGRESS DELETED

optionMetadata

object

The metadata of the attribute option.

validationRuleId

string

The validation rule configured for the attribute.

associatedAttributeFieldName

string

The fieldName parameter value of the attribute.

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://hostname/api/issue-management/v1/attributes?schemaName=Issue' \
3
     --header 'accept: application/json'

Choose an example:

application/json

*/*

OneTrust Internal Users: DO NOT MAKE ANY DIRECT CHANGES!

200OK

429Too Many Requests. For more information, see API Rate Limits.