This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

Account References

Type: object

Interface for the source system to provide reference values (enumerations) for any reference type linked with account or user data
Example:

{
    "eventHeader": {
        "source": "OPCO",
        "version": "v1"
    },
    "action": "UPSERT",
    "referenceType": "JOB_TITLE",
    "entries": [
        {
            "code": "60",
            "label": {
                "fr-FR": "Directeur de production",
                "en-GB": "Production Director"
            },
            "order": 1
        },
        {
            "code": "61",
            "label": {
                "fr-FR": "Chef de projet",
                "en-GB": "Project Manager"
            },
            "order": 2
        }
    ]
}

root eventHeader
Type: object

This object is used to describe some technical meta information related to the event

root eventHeader source
Type: enum (of string)

The application source of this event

Must be one of:

  • "SPARK_AX"
  • "OPCO"

root eventHeader version
Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"

root action
Type: enum (of string)

Action that needs to be performed on the data provided in the event

Must be one of:

  • "UPSERT"
  • "DELETE"

root referenceType
Type: enum (of string)

The type of this reference list

Must be one of:

  • "JOB_TITLE"
  • "END_MARKET_SEGMENTATION"
  • "CUSTOMER_SEGMENTATION"
  • "CUSTOMER_ACTIVITY"
  • "CUSTOMER_CONTRACT_TERM"

root entries
Type: array

The list of entries to impact

Must contain a minimum of 1 items

Must contain a maximum of 2000 items

No Additional Items

Each item of this array must be:

root entries ReferenceItem

ReferenceItem

Type: object

One item of a reference list

root entries ReferenceItem code
Type: string

The identifier of this reference item
Examples:

"60"

"61"

root entries ReferenceItem label

Multilingual Object

Type: object

The label to display to the end user
Examples:

{
    "fr-FR": "Directeur de production",
    "en-GB": "Production Director"
}

{
    "fr-FR": "Chef de projet",
    "en-GB": "Project Manager"
}

Each additional property must conform to the following schema

root entries ReferenceItem label additionalProperties
Type: string

root entries ReferenceItem order
Type: integer

The order of this reference item into the list

root entries ReferenceItem level
Type: integer

The level of this reference item in case of reference list is hierarchical.

Value must be greater or equal to 1

root entries ReferenceItem childrenCodes
Type: array of string

Reference the children items. This is used for the case where this reference list is hierarchical.

 No Additional Items

Each item of this array must be:

root entries ReferenceItem childrenCodes childrenCodes items
Type: string

The code of another Reference Item