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

Project Sync Event

Type: object

In Pilot This schema is used to synchronize project data from various sources into and out of the Spark AX system. It includes details about the project, its status, associated product categories, and bidding customers.

 No Additional Properties

root allOf item 0
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 0 if
Type: object

root allOf item 0 if eventHeader
Type: object

root allOf item 0 if eventHeader scopes
Type: array
No Additional Items

At least one of the items must be:

root allOf item 0 if eventHeader scopes contains
Type: const
Specific value: "PROJECT_HEADER"
root allOf item 0 then
Type: object

The following properties are required:

  • projectHeader
root allOf item 1
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 1 if
Type: object

root allOf item 1 if eventHeader
Type: object

root allOf item 1 if eventHeader scopes
Type: array
No Additional Items

At least one of the items must be:

root allOf item 1 if eventHeader scopes contains
Type: const
Specific value: "PROJECT_DETAILS"
root allOf item 1 then
Type: object

The following properties are required:

  • projectDetails
root allOf item 2
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 2 if
Type: object

root allOf item 2 if eventHeader
Type: object

root allOf item 2 if eventHeader scopes
Type: array
No Additional Items

At least one of the items must be:

root allOf item 2 if eventHeader scopes contains
Type: const
Specific value: "PROJECT_PRODUCT_CATEGORIES"
root allOf item 2 then
Type: object

The following properties are required:

  • projectProductCategories
root allOf item 3
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 3 if
Type: object

root allOf item 3 if eventHeader
Type: object

root allOf item 3 if eventHeader scopes
Type: array
No Additional Items

At least one of the items must be:

root allOf item 3 if eventHeader scopes contains
Type: const
Specific value: "BIDDING_CUSTOMERS"
root allOf item 3 then
Type: object

The following properties are required:

  • biddingCustomers

root eventHeader
Type: object

Metadata about the event, including its source, version, type, operating company, and scopes.

 No Additional Properties

root eventHeader source
Type: enum (of string)

The source system of the event

Must be one of:

  • "SPARK_AX"

Example:

"SPARK-AX"

root eventHeader version
Type: string

The version of the event schema.

Must be at least 1 characters long


Example:

"v1"

root eventHeader type
Type: enum (of string)

The type of event. COMMAND is going to be used by systems of engagement to send data to the system of record (master). EVENT is going to be used by the system of record to broadcast changes to other systems. For now, only EVENT is supported.

Must be one of:

  • "EVENT"

Example:

"EVENT"

root eventHeader opcoId
Type: string

The operating company identifier.

Must be at least 1 characters long


Examples:

"BEL-CEBEO"

"ITA-SONITA"

root eventHeader scopes
Type: array of enum (of string)

The scopes of the event indicating which parts of the project data are included in the event.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root eventHeader scopes scopes items
Type: enum (of string)

Must be one of:

  • "PROJECT_HEADER"
  • "PROJECT_DETAILS"
  • "PROJECT_PRODUCT_CATEGORIES"
  • "BIDDING_CUSTOMERS"

Examples:

"PROJECT_HEADER"

"PROJECT_DETAILS"

"PROJECT_PRODUCT_CATEGORIES"

"BIDDING_CUSTOMERS"

root identifier
Type: object

The object holding the identifier for the project
Example:

{
    "projectId": "123456780912345678"
}

root identifier projectId
Type: string

Unique identifier for the project in the source system.

Must be at least 1 characters long

root projectHeader
Type: object

Basic information about the project.

 No Additional Properties

root projectHeader projectName
Type: string

The name of the project.

Must be at least 1 characters long


Examples:

"Project Alpha"

"New Store Launch"

root projectHeader projectDescription
Type: string

A brief description of the project.

Must be at least 1 characters long


Examples:

"A sample project for demonstration purposes"

"Launching a new retail store in downtown"

root projectHeader projectId
Type: string

The unique identifier of the project as generated by AX.

Must be at least 1 characters long


Example:

"GUID-12345"

root projectHeader parentProjectId
Type: string

The unique identifier of the parent project if applicable.

Must be at least 1 characters long


Example:

"GUID-54321"

root projectHeader bidDate
Type: stringFormat: date

The date by which bids for the project are due.
Example:

"2024-06-15"

root projectHeader awardDate
Type: stringFormat: date

The date when the project was awarded.
Example:

"2024-07-01"

root projectHeader projectManagerEmail
Type: stringFormat: email

The email address of the project manager.
Example:

"project.manager@example.com"

root projectDetails
Type: object

Detailed information about the project.

 No Additional Properties

root projectDetails projectType
Type: enum (of string)

The type of the project. The enum values will be provided by Ali.

Must be one of:

  • "type1"

root projectDetails status
Type: enum (of string)

The status of the project or product category.

Must be one of:

  • "WON"
  • "LOST"
  • "CANCELLED"
  • "NOT_AWARDED"
  • "PARTIALLY_AWARDED"
  • "FULLY_AWARDED"
  • "ON_HOLD"

root projectDetails totalEstimatedValue
Type: object

The total estimated value of the project.

root projectDetails totalEstimatedValue amount
Type: number

The monetary amount.

Value must be greater or equal to 0

root projectDetails totalEstimatedValue scale
Type: integer

The number of decimal places.

Value must be greater or equal to 0

root projectDetails totalEstimatedValue currency
Type: string

The currency code (ISO 4217).

Must be at least 3 characters long

Must be at most 3 characters long


Examples:

"EUR"

"USD"

root projectDetails projectAddress
Type: object

The address associated with the project.

root projectDetails projectAddress addressLine1
Type: string

The first line of the address. Ussually the whole address should fit here.

Must be at least 1 characters long

root projectDetails projectAddress addressLine2
Type: string

The second line of the address.

Must be at least 1 characters long

root projectDetails projectAddress addressLine3
Type: string

The third line of the address.

Must be at least 1 characters long

root projectDetails projectAddress city
Type: string

The city of the address.

Must be at least 1 characters long

root projectDetails projectAddress country
Type: string

The country code (ISO 3166 alpha-3).

Must be at least 3 characters long

Must be at most 3 characters long


Examples:

"FRA"

"USA"

root projectDetails projectAddress postalCode
Type: string

The postal code of the address.

Must be at least 1 characters long

root projectProductCategories
Type: array of object

List of product categories associated with the project.

 No Additional Items

Each item of this array must be:

root projectProductCategories projectProductCategories items
Type: object
No Additional Properties

root projectProductCategories projectProductCategories items productCategoryId
Type: string

The identifier of the product category.

Must be at least 1 characters long

root projectProductCategories projectProductCategories items status
Type: enum (of string)

The status of the project or product category.

Must be one of:

  • "WON"
  • "LOST"
  • "CANCELLED"
  • "NOT_AWARDED"
  • "PARTIALLY_AWARDED"
  • "FULLY_AWARDED"
  • "ON_HOLD"

root projectProductCategories projectProductCategories items estimatedValue
Type: object

The total estimated value of the project.

root projectProductCategories projectProductCategories items estimatedValue amount
Type: number

The monetary amount.

Value must be greater or equal to 0

root projectProductCategories projectProductCategories items estimatedValue scale
Type: integer

The number of decimal places.

Value must be greater or equal to 0

root projectProductCategories projectProductCategories items estimatedValue currency
Type: string

The currency code (ISO 4217).

Must be at least 3 characters long

Must be at most 3 characters long


Examples:

"EUR"

"USD"

root projectProductCategories projectProductCategories items bidDate
Type: stringFormat: date

The date by which bids for this product category are due.
Example:

"2024-06-15"

root projectProductCategories projectProductCategories items awardDate
Type: stringFormat: date

The date when the product category was awarded.
Example:

"2024-07-01"

root biddingCustomers
Type: array of object

List of customers bidding for the project.

 No Additional Items

Each item of this array must be:

root biddingCustomers biddingCustomers items
Type: object
No Additional Properties

root biddingCustomers biddingCustomers items opCoAccountId
Type: string

The operating company account identifier of the bidding customer.

Must be at least 1 characters long

root biddingCustomers biddingCustomers items biddingProductCategories
Type: array of object

List of product categories the customer is bidding for.

 No Additional Items

Each item of this array must be:

root biddingCustomers biddingCustomers items biddingProductCategories biddingProductCategories items
Type: object
No Additional Properties

root biddingCustomers biddingCustomers items biddingProductCategories biddingProductCategories items productCategoryId
Type: string

The identifier of the product category.

Must be at least 1 characters long

root biddingCustomers biddingCustomers items biddingProductCategories biddingProductCategories items status
Type: enum (of string)

The status of the project or product category.

Must be one of:

  • "WON"
  • "LOST"
  • "CANCELLED"
  • "NOT_AWARDED"
  • "PARTIALLY_AWARDED"
  • "FULLY_AWARDED"
  • "ON_HOLD"

root biddingCustomers biddingCustomers items dealDate
Type: stringFormat: date

The date when the deal with the customer is planned to be closed.
Example:

"2024-06-20"

root biddingCustomers biddingCustomers items bidDate
Type: stringFormat: date

The date by which the customer submitted their bid.
Example:

"2024-06-20"

root biddingCustomers biddingCustomers items awardDate
Type: stringFormat: date

The date when the customer was awarded the project.
Example:

"2024-07-01"