Get attribute data in bulk​
This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters
Query Parameters
- query object
Allows for pagination and sorting using the deepObject notation.
resource?query[limit]=50&query[offset]=0&query[order]=label
Parameter Description Default limit Limits the number of results returned 100 offset Returns the results starting at the value provided 0 order Allows you to determine the order in which the data is returned (not available on profile attributes) id Example: query[limit]=100&query[offset]=50&query[order]=created_at - label string
The attribute label to filter by
Example: mylabel - data_type string
Possible values: [
text field
,text area
,drop-down
,radio buttons
,check boxes
,date
,tags
,attachment
,profile select
,profile search
,owner select
,owner search
,contributor select
,contributor search
]The attribute data type to filter by
Example: radio buttons - metadata boolean
Returns batching metadata in the response
Example: true
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
ne_attributes object[]
id uuidThe id
uid stringPossible values:
>= 32 characters
and<= 32 characters
The uid
label stringThe label
description stringThe description
tool_tip stringThe tool tip
crypt booleanShould this be encrypted?
archived booleanIs this attribute archived?
archived_on date-timeWhen was this attribute archved
created_at date-timeThe created_at time
updated_at date-timeThe updated_at time
date_format stringPossible values: [
mm/dd/yyyy
,mm-dd-yyyy
,dd/mm/yyyy
,dd-mm-yyyy
,yyyy/mm/dd
,yyyy-mm-dd
]The format of the date
selectable_status stringThe selectable_status
risk_score_setting stringThe risk score setting
risk_type stringThe risk type
ownership_driver booleanThe ownership_driver
allow_multiple_selections booleanallow multiple selections
filtered_by_ne_attribute booleanShould this attribute be filtered_by_ne_attribute
filtering_ne_attribute_id uuidThe ne_attribute_id to use for filtering
ne_attribute_filter_id uuidThe ne_attribute_id to filter by
reverse_association_attribute_id uuidThe reverse association ne_attribute_id
profile_type_id uuidThe profile_type_id
legacy_id int32The legacy ID
tmp_created_at date-time(Deprecated) The temporary created_at field
tmp_updated_at date-time(Deprecated) The temporary updated_at field
_metadata object
limit int32The limit
offset int32The offset
total int32The total
next stringThe link to the next page of data
previous stringThe link to the previous page of data
{
"ne_attributes": [
{
"id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"label": "my_attribute",
"description": "This is my attribute",
"tool_tip": "my attribute",
"crypt": true,
"archived": false,
"archived_on": "2023-05-01T09:12:28Z",
"created_at": "2023-05-01T09:12:28Z",
"updated_at": "2023-05-01T09:12:28Z",
"date_format": "mm/dd/yyyy",
"selectable_status": "Active",
"risk_score_setting": "standard",
"risk_type": "inherited",
"ownership_driver": true,
"allow_multiple_selections": false,
"filtered_by_ne_attribute": false,
"filtering_ne_attribute_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"ne_attribute_filter_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"reverse_association_attribute_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"profile_type_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"legacy_id": 123,
"tmp_created_at": "2023-05-01T09:12:28Z",
"tmp_updated_at": "2023-05-01T09:12:28Z"
}
],
"_metadata": {
"limit": 50,
"offset": 100,
"total": 10000,
"next": "/endpoint?limit=10&offset=60",
"previous": "/endpoint?limit=10&offset=40"
}
}
Bad Request - unable to complete.
- application/json
- Schema
- Example (from schema)
Schema
- MOD1
- MOD2
- error
- error
- errors
{
"error": "Invalid JSON syntax. Please check your syntax and try again."
}
Internal Server Error - returned on unhandled exceptions.
- application/json
- Schema
- Example (from schema)
Schema
- error
A message describing the error
{
"error": "Sorry something went wrong"
}