Skip to main content

Create an attribute

POST 

/ne_attributes

This endpoint can create an attribute

Request

Body

required
    ne_attribute object
    label string

    The label for the attribute

    description string

    A description of the attribute

    tool_tip string

    The helper text that accompanies the attribute

    archived boolean

    Whether the attribute is archived

    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 input if it is a date input

    selectable_status string

    The status of the profiles that can be selected

    risk_type string

    Type of risk that applies to the attribute

    ownership_driver boolean

    Only shows profiles that the user currently has access to, to be selected

    allow_multiple_selections boolean

    Whether or not multiple selections can be made on something like a contributor search.

    filtered_by_ne_attribute boolean

    Whether or not the attribute is filtered by another attribute

    filtering_ne_attribute_id uuid

    The ID of the filtering attribute

    ne_attribute_filter_id uuid

    The ID of the attribute filter

    reverse_association_attribute object
    label string

    The label for the attribute

    description string

    A description of the attribute

    tool_tip string

    The helper text that accompanies the attribute

    crypt boolean

    Whether or not the attribute is encrypted

    archived boolean

    Whether the attribute is archived

    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 input if it is a date input

    selectable_status string

    The status of the profiles that can be selected

    risk_score_setting string

    What setting is used for the risk score

    risk_type string

    Type of risk that applies to the attribute

    ownership_driver boolean

    Only shows profiles that the user currently has access to, to be selected

    allow_multiple_selections boolean

    Whether or not multiple selections can be made on something like a contributor search.

    filtered_by_ne_attribute boolean

    Whether or not the attribute is filtered by another attribute

    filtering_ne_attribute_id uuid

    The ID of the filtering attribute

    ne_attribute_filter_id uuid

    The ID of the attribute filter

    reverse_association_attribute_id uuid

    The ID of the attribute used with reverse association

    profile_type_id uuid

    The ID of the profile type the attribute applies to

    legacy_id uuid

    The legacy ID

    profile_type_id uuid

    The ID of the profile type the attribute applies to

    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 type of data that applies to the attribute

    type string

    Possible values: [AttachmentAttribute, CheckBoxesAttribute, ContributorSearchAttribute, ContributorSelectAttribute, DateAttribute, DropDownAttribute, OwnerSearchAttribute, OwnerSelectAttribute, ProfileSearchAttribute, ProfileSelectAttribute, RadioButtonsAttribute, TagsAttribute, TextAreaAttribute, TextFieldAttribute]

    The attribute's type

    validations_attributes object
    validation_method string

    Possible values: [required, unique, date_format, days, characters, extension, numericality, email_format, custom_format, no_special_chars]

    The type of validation to be applied

    value string

    The value of the validator

    _destroy boolean

    If the validator should be removed

Responses

Expected response to a valid request

Schema
    ne_attribute object
    id uuid

    The id of the attribute

    uid string

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

    The uid of the attribute

    label string

    The label for the attribute

    description string

    A description of the attribute

    tool_tip string

    The helper text that accompanies the attribute

    crypt boolean

    Whether the attribute is encrypted

    archived boolean

    Whether the attribute is archived

    archived_on date-time

    When the attribute was archived

    created_at date-time

    When the attribute was created

    updated_at date-time

    When the attribute was updated

    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 input if it is a date input

    selectable_status string

    The status of the profiles that can be selected

    risk_type string

    Type of risk that applies to the attribute

    ownership_driver boolean

    Only shows profiles that the user currently has access to, to be selected

    allow_multiple_selections boolean

    Whether or not multiple selections can be made on something like a contributor search.

    filtered_by_ne_attribute boolean

    Whether or not the attribute is filtered by another attribute

    filtering_ne_attribute_id uuid

    The ID of the filtering attribute

    ne_attribute_filter_id uuid

    The ID of the attribute filter

    reverse_association_attribute object
    id uuid

    The id of the attribute

    uid string

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

    The uid of the attribute

    label string

    The label for the attribute

    description string

    A description of the attribute

    tool_tip string

    The helper text that accompanies the attribute

    crypt boolean

    Whether or not the attribute is encrypted

    archived boolean

    Whether the attribute is archived

    archived_on date-time

    When the attribute was archived

    created_at date-time

    When the attribute was created

    updated_at date-time

    When the attribute was last updated

    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 input if it is a date input

    selectable_status string

    The status of the profiles that can be selected

    risk_score_setting string

    What setting is used for the risk score

    risk_type string

    Type of risk that applies to the attribute

    ownership_driver boolean

    Only shows profiles that the user currently has access to, to be selected

    allow_multiple_selections boolean

    Whether or not multiple selections can be made on something like a contributor search.

    filtered_by_ne_attribute boolean

    Whether or not the attribute is filtered by another attribute

    filtering_ne_attribute_id uuid

    The ID of the filtering attribute

    ne_attribute_filter_id uuid

    The ID of the attribute filter

    reverse_association_attribute_id uuid

    The ID of the attribute used with reverse association

    profile_type_id uuid

    The ID of the profile type the attribute applies to

    legacy_id uuid

    The legacy ID

    tmp_created_at date-time

    the temp of when attribute was created

    tmp_updated_at date-time

    the temp of when attribute was last updated

    profile_type_id uuid

    The ID of the profile type the attribute applies to

    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 type of data that applies to the attribute

    type string

    Possible values: [AttachmentAttribute, CheckBoxesAttribute, ContributorSearchAttribute, ContributorSelectAttribute, DateAttribute, DropDownAttribute, OwnerSearchAttribute, OwnerSelectAttribute, ProfileSearchAttribute, ProfileSelectAttribute, RadioButtonsAttribute, TagsAttribute, TextAreaAttribute, TextFieldAttribute]

    The attribute's type

Loading...