Skip to main content

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


    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows 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
Responses

Expected response to a valid request


Schema
  • ne_attributes object[]
  • id uuid

    The id

  • uid string

    Possible values: >= 32 characters and <= 32 characters

    The uid

  • label string

    The label

  • description string

    The description

  • tool_tip string

    The tool tip

  • crypt boolean

    Should this be encrypted?

  • archived boolean

    Is this attribute archived?

  • archived_on date-time

    When was this attribute archved

  • created_at date-time

    The created_at time

  • updated_at date-time

    The updated_at time

  • date_format string

    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

  • selectable_status string

    The selectable_status

  • risk_score_setting string

    The risk score setting

  • risk_type string

    The risk type

  • ownership_driver boolean

    The ownership_driver

  • allow_multiple_selections boolean

    allow multiple selections

  • filtered_by_ne_attribute boolean

    Should this attribute be filtered_by_ne_attribute

  • filtering_ne_attribute_id uuid

    The ne_attribute_id to use for filtering

  • ne_attribute_filter_id uuid

    The ne_attribute_id to filter by

  • reverse_association_attribute_id uuid

    The reverse association ne_attribute_id

  • profile_type_id uuid

    The profile_type_id

  • legacy_id int32

    The 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 int32

    The limit

  • offset int32

    The offset

  • total int32

    The total

  • next string

    The link to the next page of data

  • previous string

    The link to the previous page of data

Loading...