Search Control Implementation Attributes

post https://customer-my-onetrust-com.ezp-prod1.hul.harvard.edu/api/control/v1/control-implementation-attributes/search

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

Responses

Response body

array of objects

object

allowOther

boolean

Indicator for allowing user defined options for attribute.

associatedAttributeInformation

array of objects

Associated attributes information for given attribute.

associatedAttributeInformation

object

description

string

Attribute description.

descriptionKey

string

Attribute description key.

enabled

boolean

required

Indicator for attribute enabled/disabled.

fieldName

string

required

Attribute field name.

formula

string

Formula for attribute.

uuid

required

Attribute GUID.

mappedFieldName

string

Mapped Attribute field name. Should be used for sorting.

name

string

required

Attribute name.

nameKey

string

Attribute name key.

options

array of objects

Option's for given attribute based on response type.

options

object

enabled

boolean

The flag to check if the option is enabled or disabled.

uuid

Option GUID.

option

string

Option Name.

optionKey

string

Option Key which can be used for translation.

responseSubType

string

Response sub type for attribute.

Standard Formula

responseType

string

required

Response type for attribute.

Text SingleSelect MultiSelect Date DateTime NumericalText NumericalSingleSelect RadioButton TextArea Formula

schemaId

uuid

Attribute Schema GUID.

schemaName

string

Attribute Schema Name.

baseAttribute

boolean

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

description

string

Attribute description.

descriptionKey

string

Attribute description key.

enabled

boolean

required

Indicator for attribute enabled/disabled.

fieldName

string

required

Attribute field name.

formula

string

Formula for attribute.

hidden

boolean

Indicator for attribute hidden/visible.

uuid

Attribute GUID.

mappedFieldName

string

Mapped Attribute field name. Should be used for sorting.

multiSelectMaxOptionValues

int32

Maximum values allowed for multiselect.

name

string

required

Attribute name.

nameKey

string

Attribute name key.

optionAllowed

boolean

Indicate if attribute can have static options or not.

optionType

string

Attribute Options value source type.

options

array of objects

Option's for given attribute based on response type.

options

object

enabled

boolean

The flag to check if the option is enabled or disabled.

uuid

Option GUID.

option

string

Option Name.

optionKey

string

Option Key which can be used for translation.

readOnly

boolean

Indicator for read only attribute.

referenceCategories

array of objects

Categories for given attribute.

referenceCategories

object

uuid

Primary Identifier.

name

string

Category Name of Control. Optional if Category Id is provided.

nameKey

string

Category Name key for translation. Optional if Category Id is provided.

required

boolean

Indicator for mandatory attribute.

responseMaxLength

int32

Response maximun length.

responseSubType

string

Response sub type for attribute.

Standard Formula

responseType

string

Response type for attribute.

Text SingleSelect MultiSelect Date DateTime NumericalText NumericalSingleSelect RadioButton TextArea Formula

schemaId

uuid

Attribute Schema GUID.

schemaName

string

Attribute Schema Name.

source

string

Source of the Attribute.

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://customer-my-onetrust-com.ezp-prod1.hul.harvard.edu/api/control/v1/control-implementation-attributes/search \
3
     --header 'accept: application/json' \
4
     --header 'content-type: 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.