Get attribute data in bulk
GET/ne_attributes
This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters
Request
Query Parameters
Allows for pagination and sorting.
The attribute label to filter by
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
Returns batching metadata in the response
Responses
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
ne_attributes object[]
The id of the attribute
Possible values: >= 32 characters
and <= 32 characters
The uid of the attribute
The label for the attribute
A description of the attribute
The helper text that accompanies the attribute
Whether the attribute is encrypted
Whether the attribute is archived
When the attribute was archived
When the attribute was created
When the attribute was updated
Possible values: [mm/dd/yyyy
, mm-dd-yyyy
, dd/mm/yyyy
, dd-mm-yyyy
, yyyy/mm/dd
, yyyy-mm-dd
]
The format of the date input if it is a date input
The status of the profiles that can be selected
Type of risk that applies to the attribute
Only shows profiles that the user currently has access to, to be selected
Whether or not multiple selections can be made on something like a contributor search.
Whether or not the attribute is filtered by another attribute
The ID of the filtering attribute
The ID of the attribute filter
reverse_association_attribute object
The id of the attribute
Possible values: >= 32 characters
and <= 32 characters
The uid of the attribute
The label for the attribute
A description of the attribute
The helper text that accompanies the attribute
Whether or not the attribute is encrypted
Whether the attribute is archived
When the attribute was archived
When the attribute was created
When the attribute was last updated
Possible values: [mm/dd/yyyy
, mm-dd-yyyy
, dd/mm/yyyy
, dd-mm-yyyy
, yyyy/mm/dd
, yyyy-mm-dd
]
The format of the date input if it is a date input
The status of the profiles that can be selected
What setting is used for the risk score
Type of risk that applies to the attribute
Only shows profiles that the user currently has access to, to be selected
Whether or not multiple selections can be made on something like a contributor search.
Whether or not the attribute is filtered by another attribute
The ID of the filtering attribute
The ID of the attribute filter
The ID of the attribute used with reverse association
The ID of the profile type the attribute applies to
The legacy ID
the temp of when attribute was created
the temp of when attribute was last updated
The ID of the profile type the attribute applies to
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 type of data that applies to the attribute
Possible values: [AttachmentAttribute
, CheckBoxesAttribute
, ContributorSearchAttribute
, ContributorSelectAttribute
, DateAttribute
, DropDownAttribute
, OwnerSearchAttribute
, OwnerSelectAttribute
, ProfileSearchAttribute
, ProfileSelectAttribute
, RadioButtonsAttribute
, TagsAttribute
, TextAreaAttribute
, TextFieldAttribute
]
The attribute's type
_metadata object
{
"ne_attributes": [
{
"id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"uid": "myattribute",
"label": "birthday",
"description": "Your birthday",
"tool_tip": "Put your birthday here mm-dd-yyyy",
"crypt": false,
"archived": false,
"archived_on": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"created_at": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"updated_at": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"date_format": "mm/dd/yyyy",
"selectable_status": "Active",
"risk_type": "OverallRisk",
"ownership_driven": true,
"allow_multiple_selections": true,
"filtered_by_ne_attribute": true,
"filtering_ne_attribute_id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"ne_attribute_filter_id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"reverse_association_attribute": {
"id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"uid": "myattribute",
"label": "birthday",
"description": "Your birthday",
"tool_tip": "Put your birthday here mm-dd-yyyy",
"crypt": false,
"archived": false,
"archived_on": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"created_at": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"updated_at": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"date_format": "mm/dd/yyyy",
"selectable_status": "Active",
"risk_score_setting": "standard",
"risk_type": "OverallRisk",
"ownership_driven": true,
"allow_multiple_selections": true,
"filtered_by_ne_attribute": true,
"filtering_ne_attribute_id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"ne_attribute_filter_id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"reverse_association_attribute_id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"profile_type_id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"legacy_id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"tmp_created_at": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"tmp_updated_at": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00"
},
"profile_type_id": "ac4aae0b-4140-49a4-a84c-126762fd0c8f",
"data_type": "text field",
"type": "AttachmentAttribute"
}
],
"_metadata": {
"limit": 0,
"offset": 0,
"total": 0,
"next": "/endpoint?limit=10&offset=60",
"previous": "/endpoint?limit=10&offset=40"
}
}
Bad Request - unable to complete.
- application/json
- Schema
- Example (from schema)
Schema
- InvalidJson
- ValidationErrors
{}
Internal Server Error - returned on unhandled exceptions.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "Sorry something went wrong"
}