Skip to main content

Patch a Schema Attribute for Non-Employee Source

This end-point patches a specific schema attribute for a non-employee SourceId.

Request will require a security scope of:

'idn:nesr:update'

Path Parameters
  • attributeId string required

    The Schema Attribute Id (UUID)

  • sourceId string required

    The Source id

Request Body array required

A list of schema attribute update operations according to the JSON Patch standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.

  • op string required

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

  • path string required

    A string JSON Pointer representing the target path to an element to be affected by the operation

  • value object

    The value to be used for the operation, required for "add" and "replace" operations

    anyOf

  • string
Responses

The Schema Attribute was successfully patched.


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...