Skip to main content

Get Schema Attribute Non-Employee Source

This API gets a schema attribute by Id for the specified Non-Employee SourceId.

Path Parameters
  • attributeId string required

    The Schema Attribute Id (UUID)

    Example: 2c918085842e69ae018432d22ccb212f
  • sourceId string required

    The Source id

    Example: 2c918085842e69ae018432d22ccb212f
Responses

The Schema Attribute


Schema
  • 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 string

    Possible values: [TEXT, DATE, IDENTITY]

    Enum representing the type of data a schema attribute accepts.

  • label string

    Label displayed on the UI for this schema attribute.

  • technicalName string

    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

Loading...