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. Requires role context of idn:nesr:update


Path Parameters

    attributeId stringrequired

    The Schema Attribute Id (UUID)

    Example: ef38f94347e94562b5bb8424a56397d8
    sourceId stringrequired

    The Source id

    Example: ef38f94347e94562b5bb8424a56397d8



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

  • Array [
  • op stringrequired

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

    The operation to be performed

    path stringrequired

    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



  • ]


The Schema Attribute was successfully patched.

    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