Skip to main content

Get Schema Attribute Non-Employee Source



This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of idn:nesr:read or the user must be an account manager of the source.


Path Parameters

    attributeId stringrequired

    The Schema Attribute Id (UUID)

    Example: ef38f94347e94562b5bb8424a56397d8
    sourceId stringrequired

    The Source id

    Example: ef38f94347e94562b5bb8424a56397d8


The Schema Attribute

    id UUID

    Schema Attribute Id

    system boolean

    True if this schema attribute is mandatory on all non-employees sources.

    modified date-time

    When the schema attribute was last modified.

    created date-time

    When the schema attribute was created.

    type NonEmployeeSchemaAttributeTyperequired

    Possible values: [TEXT, DATE, IDENTITY]

    Enum representing the type of data a schema attribute accepts.

    label stringrequired

    Label displayed on the UI for this schema attribute.

    technicalName stringrequired

    The technical name of the attribute. Must be unique per source.

    helpText string

    help text displayed by UI.

    placeholder string

    Hint text that fills UI box.

    required boolean

    If true, the schema attribute is required for all non-employees in the source