MES Canonical Event Definition 11.3

Operations

• RECEIVE CDM_Calendar_CalendarDay

  The topic on to synchronize calendar day changes

  Operation IDCalendarDay

  Accepts the following message:

  CalendarDayEvent

  Create / update calendar day

  • application/json

  Message IDCalendarDayEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Calendar,CalendarDay,Area]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Calendar Day:

  Expand all

  object [Calendar Day]

  CalendarDay

  Expand all

  required

  object allOf

  Calendar information regarding the time of the event

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Calendar Day Payload:

  Expand all

  object [Calendar Day Payload]

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  CD

  required

  string

  format: date

  The event calendar day

  Examples values:
  • "2025-02-11T00:00:00"
  • "2025-02-11"

  FY

  required

  integer

  The event fiscal year

  Examples values:
  • 2025

  FQ

  required

  integer

  [ 1 .. 4 ]

  The event fiscal quarter

  FM

  required

  integer

  [ 1 .. 12 ]

  The event fiscal month

  FW

  required

  integer

  [ 1 .. 53 ]

  The event fiscal week

  Shifts

  Expand all

  array<object allOf>

  >= 0

  Items:

  object allOf

  The event shift Full information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Shift Full Payload:

  Expand all

  object [Shift Full Payload]

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  ShiftDefinitionName

  required

  string

  The event shift definition

  Examples values:
  • "Shift Definition Name"

  StartTime

  required

  string

  format: date-time

  The event shift start time

  Examples values:
  • "2025-02-18T18:00:00Z"

  EndTime

  required

  string

  format: date-time

  The event shift end time

  Examples values:
  • "2025-02-19T02:00:00Z"

  StartTimeUTC

  required

  string

  format: date-time

  The event shift start time in UTC

  Examples values:
  • "2023-09-14T23:00:00"

  EndTimeUTC

  required

  string

  format: date-time

  The event shift end time in UTC

  Examples values:
  • "2023-09-15T07:00:00"

  DataGroup

  string

  The Entity data group (for data access security purposes)

  Examples values:
  • "Data Group One"

  Team

  string

  Examples values:
  • "Team One"

  Duration

  string

  format: time

  Sum of Working Time and Non Working Time

  Examples values:
  • "08:00:00"

  WorkingTime

  string

  format: time

  Examples values:
  • "07:00:00"

  NonWorkingTime

  string

  format: time

  Examples values:
  • "01:00:00"

  NonWorkingTimes

  Expand all

  array<object>

  Non Working Times formatted as JSON array with information about the Name, Start and End Time

  object

  Name

  required

  string

  Examples values:
  • "Lunch"
  • "Break"

  StartTime

  required

  string

  format: date-time

  Examples values:
  • "2023-09-15T12:00:00"

  EndTime

  required

  string

  format: date-time

  Examples values:
  • "2023-09-15T13:00:00"

  StartTimeUTC

  required

  string

  format: date-time

  Examples values:
  • "2023-09-15T11:00:00"

  EndTimeUTC

  required

  string

  format: date-time

  Examples values:
  • "2023-09-15T12:00:00"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Calendar

  Expand all

  required

  allOf

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Calendar:

  Expand all

  object [Calendar]

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  Additional properties are allowed.

  Area

  Expand all

  required

  object allOf

  The Basic Area information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Basic Area Payload:

  Expand all

  object [Basic Area Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #Calendar

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Calendar",
        "CalendarDay",
        "Area"
      ],
      "DataGroups": [
        [
          "2502181710210000001",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181712430124398",
          "2502181710210006855"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "CalendarDay": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "UniversalState": "Active",
      "CD": "2025-02-11T00:00:00",
      "FY": 2025,
      "FQ": 1,
      "FM": 1,
      "FW": 1,
      "Shifts": [
        {
          "UID": "2502130212590000467",
          "Name": "Name",
          "CreatedOn": "2025-02-12T20:13:48.047",
          "CreatedBy": "2502130212590000005",
          "ModifiedOn": "2025-02-12T20:13:50.367",
          "ModifiedBy": "2502130212590000005",
          "UniversalState": "Active",
          "ShiftDefinitionName": "Shift Definition Name",
          "StartTime": "2025-02-18T18:00:00Z",
          "EndTime": "2025-02-19T02:00:00Z",
          "StartTimeUTC": "2023-09-14T23:00:00",
          "EndTimeUTC": "2023-09-15T07:00:00",
          "DataGroup": "Data Group One",
          "Team": "Team One",
          "Duration": "08:00:00",
          "WorkingTime": "07:00:00",
          "NonWorkingTime": "01:00:00",
          "NonWorkingTimes": [
            {
              "Name": "Lunch",
              "StartTime": "2023-09-15T12:00:00",
              "EndTime": "2023-09-15T13:00:00",
              "StartTimeUTC": "2023-09-15T11:00:00",
              "EndTimeUTC": "2023-09-15T12:00:00"
            }
          ]
        }
      ]
    },
    "Calendar": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "UniversalState": "Active",
      "Timezone": "GMT Standard Time"
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Material_FutureMaterialMovement

  The topic contains the expected future steps of a material

  Operation IDFutureMaterialMovement

  Accepts the following message:

  Future Material MovementFutureMaterialMovementEvent

  Reports the future movement of a given material

  • application/json

  Message IDFutureMaterialMovementEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Material,Area,Flow,Step,Product,ProductGroup,ProductionOrder]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Future Material Movement:

  Expand all

  object [Future Material Movement]

  Material

  Expand all

  required

  object allOf

  The Material information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Material Full Payload:

  Expand all

  object [Material Full Payload]

  Type

  required

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  required

  string

  The form of the material.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material.

  ProcessingState

  string

  Material Processing States

  Allowed values:
  • "Queued"
  • "Dispatched"
  • "InProcess"
  • "Processed"
  • "InTransit"

  ReworkCount

  integer

  >= 0

  HoldCount

  integer

  >= 0

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  required

  object allOf

  The Basic Area information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Basic Area Payload:

  Expand all

  object [Basic Area Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Flow

  Expand all

  required

  object allOf

  The Flow information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  required

  object allOf

  The Basic Step information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  required

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductionOrder

  Expand all

  object allOf

  Consists of Production Order Basic Payload:

  Expand all

  object allOf

  The Production Order Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Production Order Basic Payload:

  Expand all

  object [Production Order Basic Payload]

  Quantity

  required

  number

  format: float

  Examples values:
  • 11

  Units

  required

  string

  Examples values:
  • "Chocolates"

  DueDate

  required

  string

  format: date-time

  Examples values:
  • "2025-02-26T11:27:11.487"

  PlannedStartDate

  string

  format: date-time

  Examples values:
  • "2025-02-14T16:28:57.160"

  PlannedEndDate

  string

  format: date-time

  Examples values:
  • "2025-02-18T16:28:57.160"

  OrderNumber

  string

  Examples values:
  • "OrderNumber"

  Additional properties are allowed.

  Additional properties are allowed.

  And of Customer Payload:

  Expand all

  object allOf

  The Customer information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  FutureSteps

  Expand all

  required

  array<allOf>

  The Full Future Steps information

  Examples values:
  • {"UID":"2505121203180000006","Name":"Mixing-2","Type":"Process","IsOptional":false,"PrimaryUnits":"Kg","SecondaryUnits":""}
  • {"UID":"2505121203180000007","Name":"Moulding-2","Type":"Process","IsOptional":false,"PrimaryUnits":"Kg","SecondaryUnits":"Cookies"}

  Items:

  allOf

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Future Step Payload:

  Expand all

  object [Future Step Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  IsOptional

  boolean

  Indicates whether the Step is optional

  PrimaryUnits

  required

  string

  Primary Units Of Measure

  SecondaryUnits

  string

  Secondary Units Of Measure

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Material",
        "Area",
        "Flow",
        "Step",
        "Product",
        "ProductGroup",
        "ProductionOrder"
      ],
      "DataGroups": [
        [
          "2502181710210000004",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "-1",
          "2502181712430124398"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Material": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "Type": "Standard",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0,
      "ProcessingState": "Queued",
      "ReworkCount": 0,
      "HoldCount": 0
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Flow": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "ProductGroup": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "ProductionOrder": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Quantity": 11,
      "Units": "Chocolates",
      "DueDate": "2025-02-26T11:27:11.487",
      "PlannedStartDate": "2025-02-14T16:28:57.160",
      "PlannedEndDate": "2025-02-18T16:28:57.160",
      "OrderNumber": "OrderNumber"
    },
    "FutureSteps": {
      "UID": "2505121203180000006",
      "Name": "Mixing-2",
      "Type": "Process",
      "IsOptional": false,
      "PrimaryUnits": "Kg",
      "SecondaryUnits": ""
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Material_HoldRelease

  The topic which contains material hold and release operations and respective quality reasons

  Operation IDHoldRelease

  Accepts the following message:

  Hold ReleaseHoldReleaseEvent

  Inform about a movement of a particular material.

  • application/json

  Message IDHoldReleaseEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Material,ParentMaterial,Reason,Area,Resource,Flow,Step,Product,ProductGroup,ProductionOrder,Employee]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Material Hold Release:

  Expand all

  object [Material Hold Release]

  Material

  Expand all

  required

  object allOf

  The Material information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Material Full Payload:

  Expand all

  object [Material Full Payload]

  Type

  required

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  required

  string

  The form of the material.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material.

  ProcessingState

  string

  Material Processing States

  Allowed values:
  • "Queued"
  • "Dispatched"
  • "InProcess"
  • "Processed"
  • "InTransit"

  ReworkCount

  integer

  >= 0

  HoldCount

  integer

  >= 0

  Additional properties are allowed.

  Additional properties are allowed.

  ParentMaterial

  Expand all

  object allOf

  The Material information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Material Full Payload:

  Expand all

  object [Material Full Payload]

  Type

  required

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  required

  string

  The form of the material.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material.

  ProcessingState

  string

  Material Processing States

  Allowed values:
  • "Queued"
  • "Dispatched"
  • "InProcess"
  • "Processed"
  • "InTransit"

  ReworkCount

  integer

  >= 0

  HoldCount

  integer

  >= 0

  Additional properties are allowed.

  Additional properties are allowed.

  Reason

  required

  string

  Reason associated to the Hold Operation

  Action

  required

  string

  Type of change

  Allowed values:
  • "Hold"
  • "Release"

  Area

  Expand all

  required

  object allOf

  The Basic Area information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Basic Area Payload:

  Expand all

  object [Basic Area Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Resource

  Expand all

  object allOf

  The Basic Resource information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Resource Basic Payload:

  Expand all

  object [Resource Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  ResourceType

  string

  The Resource Type

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  Additional properties are allowed.

  Additional properties are allowed.

  Flow

  Expand all

  required

  object allOf

  The Flow information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  required

  object allOf

  The Basic Step information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  required

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductionOrder

  Expand all

  object allOf

  The Production Order Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Production Order Basic Payload:

  Expand all

  object [Production Order Basic Payload]

  Quantity

  required

  number

  format: float

  Examples values:
  • 11

  Units

  required

  string

  Examples values:
  • "Chocolates"

  DueDate

  required

  string

  format: date-time

  Examples values:
  • "2025-02-26T11:27:11.487"

  PlannedStartDate

  string

  format: date-time

  Examples values:
  • "2025-02-14T16:28:57.160"

  PlannedEndDate

  string

  format: date-time

  Examples values:
  • "2025-02-18T16:28:57.160"

  OrderNumber

  string

  Examples values:
  • "OrderNumber"

  Additional properties are allowed.

  Additional properties are allowed.

  Calendar

  Expand all

  object [Calendar Payload]

  Calendar information regarding the time of the event

  Calendar

  required

  string

  The calendar Name

  Examples values:
  • "CalendarName"
  • "Standard"

  CD

  required

  string

  format: date

  The event calendar day

  Examples values:
  • "2025-02-11T00:00:00"
  • "2025-02-11"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  TZToUTCInMin

  integer

  The timezone offset to UTC in minutes

  Examples values:
  • 0
  • 60

  FY

  required

  integer

  The event fiscal year

  Examples values:
  • 2025

  FQ

  required

  integer

  [ 1 .. 4 ]

  The event fiscal quarter

  FM

  required

  integer

  [ 1 .. 12 ]

  The event fiscal month

  FW

  required

  integer

  [ 1 .. 53 ]

  The event fiscal week

  Shift

  Expand all

  object [Shift Basic Payload]

  The event shift Basic information

  ShiftDefinitionName

  required

  string

  The event shift definition

  Examples values:
  • "Shift Definition Name"

  Name

  required

  string

  The event shift name

  Examples values:
  • "Shift 1"

  StartTime

  required

  string

  format: date-time

  The event shift start time

  Examples values:
  • "2025-02-18T18:00:00Z"

  EndTime

  required

  string

  format: date-time

  The event shift end time

  Examples values:
  • "2025-02-19T02:00:00Z"

  Additional properties are allowed.

  Additional properties are allowed.

  Employee

  Expand all

  object allOf

  The Employee information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Employee Payload:

  Expand all

  object [Employee Payload]

  Number

  string

  The employee number

  Examples values:
  • "Employee 001"

  Team

  string

  The employee team

  Examples values:
  • "Team A"

  Additional properties are allowed.

  Additional properties are allowed.

  Timestamp

  string

  format: date-time

  The date on which the Hold Reason was modified

  Examples values:
  • "2025-02-13T21:16:07.443"

  Comments

  string

  Hold Release Comment

  Examples values:
  • "Comments"

  Label

  string

  Hold Release Label

  Examples values:
  • "Label"

  MaterialHoldReason_UID

  required

  string

  Material Hold Reason Relation Id

  Examples values:
  • "2505121203180000011"

  Additional properties are allowed.

  • #Material

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Material",
        "ParentMaterial",
        "Reason",
        "Area",
        "Resource",
        "Flow",
        "Step",
        "Product",
        "ProductGroup",
        "ProductionOrder",
        "Employee"
      ],
      "DataGroups": [
        [
          "-1",
          "-1",
          "2502181710210000001",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "-1",
          "-1",
          "-1",
          "-1"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Material": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "Type": "Standard",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0,
      "ProcessingState": "Queued",
      "ReworkCount": 0,
      "HoldCount": 0
    },
    "ParentMaterial": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "Type": "Standard",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0,
      "ProcessingState": "Queued",
      "ReworkCount": 0,
      "HoldCount": 0
    },
    "Reason": "string",
    "Action": "Hold",
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "ResourceType": "Standard",
      "Position": 0,
      "Model": "SX1"
    },
    "Flow": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "ProductGroup": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "ProductionOrder": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Quantity": 11,
      "Units": "Chocolates",
      "DueDate": "2025-02-26T11:27:11.487",
      "PlannedStartDate": "2025-02-14T16:28:57.160",
      "PlannedEndDate": "2025-02-18T16:28:57.160",
      "OrderNumber": "OrderNumber"
    },
    "Calendar": {
      "Calendar": "CalendarName",
      "CD": "2025-02-11T00:00:00",
      "Timezone": "GMT Standard Time",
      "TZToUTCInMin": 0,
      "FY": 2025,
      "FQ": 1,
      "FM": 1,
      "FW": 1,
      "Shift": {
        "ShiftDefinitionName": "Shift Definition Name",
        "Name": "Shift 1",
        "StartTime": "2025-02-18T18:00:00Z",
        "EndTime": "2025-02-19T02:00:00Z"
      }
    },
    "Employee": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Number": "Employee 001",
      "Team": "Team A"
    },
    "Timestamp": "2025-02-13T21:16:07.443",
    "Comments": "Comments",
    "Label": "Label",
    "MaterialHoldReason_UID": "2505121203180000011"
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Material_LossBonus

  The topic which contains material losses and bonuses and respective reasons

  Operation IDLossBonus

  Accepts the following message:

  Change Material QuantityLossBonusEvent

  Inform about a quantity change of a particular material

  • application/json

  Message IDLossBonusEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Material,Area,Resource,Flow,Step,Product,ProductGroup,ProductionOrder,Employee]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Change Material Quantity:

  Expand all

  object [Change Material Quantity]

  Change

  Expand all

  required

  object [Change Quantity Payload]

  Information regarding changes on Primary and Secondary quantity

  Type

  required

  string

  Type of change

  Allowed values:
  • "Bonus"
  • "Loss"

  Reason

  required

  string

  Reason of change

  Examples values:
  • "Reason A"

  LossStep

  string

  The step in which the Loss occurred

  Examples values:
  • "Step"

  PrimaryQty

  required

  number

  format: float>= 0

  Changes on Primary Quantity

  Examples values:
  • 1

  PrimaryUnits

  required

  string

  Primary Units

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  Changes on Secondary Quantity

  Examples values:
  • 2

  SecondaryUnits

  string

  Secondary Units

  Examples values:
  • "UnitB"

  Additional properties are allowed.

  Material

  Expand all

  required

  object allOf

  The Material information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Material Full Payload:

  Expand all

  object [Material Full Payload]

  Type

  required

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  required

  string

  The form of the material.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material.

  ProcessingState

  string

  Material Processing States

  Allowed values:
  • "Queued"
  • "Dispatched"
  • "InProcess"
  • "Processed"
  • "InTransit"

  ReworkCount

  integer

  >= 0

  HoldCount

  integer

  >= 0

  Additional properties are allowed.

  Additional properties are allowed.

  MaterialHierarchy

  Expand all

  array<object>

  object

  Material

  Expand all

  required

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  ParentMaterial

  Expand all

  required

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  required

  object allOf

  The Basic Area information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Basic Area Payload:

  Expand all

  object [Basic Area Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Resource

  Expand all

  object allOf

  The Basic Resource information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Resource Basic Payload:

  Expand all

  object [Resource Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  ResourceType

  string

  The Resource Type

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  Additional properties are allowed.

  Additional properties are allowed.

  Flow

  Expand all

  required

  object allOf

  The Flow information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  required

  object allOf

  The step in which the change was detected

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  required

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductionOrder

  Expand all

  object allOf

  The Production Order Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Production Order Basic Payload:

  Expand all

  object [Production Order Basic Payload]

  Quantity

  required

  number

  format: float

  Examples values:
  • 11

  Units

  required

  string

  Examples values:
  • "Chocolates"

  DueDate

  required

  string

  format: date-time

  Examples values:
  • "2025-02-26T11:27:11.487"

  PlannedStartDate

  string

  format: date-time

  Examples values:
  • "2025-02-14T16:28:57.160"

  PlannedEndDate

  string

  format: date-time

  Examples values:
  • "2025-02-18T16:28:57.160"

  OrderNumber

  string

  Examples values:
  • "OrderNumber"

  Additional properties are allowed.

  Additional properties are allowed.

  Calendar

  Expand all

  object [Calendar Payload]

  Calendar information regarding the time of the event

  Calendar

  required

  string

  The calendar Name

  Examples values:
  • "CalendarName"
  • "Standard"

  CD

  required

  string

  format: date

  The event calendar day

  Examples values:
  • "2025-02-11T00:00:00"
  • "2025-02-11"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  TZToUTCInMin

  integer

  The timezone offset to UTC in minutes

  Examples values:
  • 0
  • 60

  FY

  required

  integer

  The event fiscal year

  Examples values:
  • 2025

  FQ

  required

  integer

  [ 1 .. 4 ]

  The event fiscal quarter

  FM

  required

  integer

  [ 1 .. 12 ]

  The event fiscal month

  FW

  required

  integer

  [ 1 .. 53 ]

  The event fiscal week

  Shift

  Expand all

  object [Shift Basic Payload]

  The event shift Basic information

  ShiftDefinitionName

  required

  string

  The event shift definition

  Examples values:
  • "Shift Definition Name"

  Name

  required

  string

  The event shift name

  Examples values:
  • "Shift 1"

  StartTime

  required

  string

  format: date-time

  The event shift start time

  Examples values:
  • "2025-02-18T18:00:00Z"

  EndTime

  required

  string

  format: date-time

  The event shift end time

  Examples values:
  • "2025-02-19T02:00:00Z"

  Additional properties are allowed.

  Additional properties are allowed.

  Employee

  Expand all

  object allOf

  The Employee information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Employee Payload:

  Expand all

  object [Employee Payload]

  Number

  string

  The employee number

  Examples values:
  • "Employee 001"

  Team

  string

  The employee team

  Examples values:
  • "Team A"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #Material

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Material",
        "Area",
        "Resource",
        "Flow",
        "Step",
        "Product",
        "ProductGroup",
        "ProductionOrder",
        "Employee"
      ],
      "DataGroups": [
        [
          "-1",
          "-1",
          "2502181710210000001",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "2502181710210000211",
          "-1"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Change": {
      "Type": "Bonus",
      "Reason": "Reason A",
      "LossStep": "Step",
      "PrimaryQty": 1,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 2,
      "SecondaryUnits": "UnitB"
    },
    "Material": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "Type": "Standard",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0,
      "ProcessingState": "Queued",
      "ReworkCount": 0,
      "HoldCount": 0
    },
    "MaterialHierarchy": [
      {
        "Material": {
          "UID": "2502130212590000467",
          "Name": "Name"
        },
        "ParentMaterial": {
          "UID": "2502130212590000467",
          "Name": "Name"
        }
      }
    ],
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "ResourceType": "Standard",
      "Position": 0,
      "Model": "SX1"
    },
    "Flow": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "ProductGroup": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "ProductionOrder": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Quantity": 11,
      "Units": "Chocolates",
      "DueDate": "2025-02-26T11:27:11.487",
      "PlannedStartDate": "2025-02-14T16:28:57.160",
      "PlannedEndDate": "2025-02-18T16:28:57.160",
      "OrderNumber": "OrderNumber"
    },
    "Calendar": {
      "Calendar": "CalendarName",
      "CD": "2025-02-11T00:00:00",
      "Timezone": "GMT Standard Time",
      "TZToUTCInMin": 0,
      "FY": 2025,
      "FQ": 1,
      "FM": 1,
      "FW": 1,
      "Shift": {
        "ShiftDefinitionName": "Shift Definition Name",
        "Name": "Shift 1",
        "StartTime": "2025-02-18T18:00:00Z",
        "EndTime": "2025-02-19T02:00:00Z"
      }
    },
    "Employee": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Number": "Employee 001",
      "Team": "Team A"
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Maintenance_MaintenanceOrder

  The topic on which all maintenance order events may be produced and consumed

  Operation IDMaintenanceOrder

  Accepts the following message:

  Maintenance OrderMaintenanceOrderEvent

  Inform about a Maintenance Order

  • application/json

  Message IDMaintenanceOrderEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,MaintenanceOrder,Area,Resource]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Maintenance Order:

  Expand all

  object [Maintenance Order]

  MaintenanceOrder

  Expand all

  required

  object allOf

  The Maintenance Order information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Maintenance Order Payload:

  Expand all

  object [Maintenance Order Payload]

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  AssociatedWith

  required

  string

  The Entity Type the Maintenance Order is associated with

  Allowed values:
  • "Resource"
  • "Container"
  • "Material"
  • "Area"

  Class

  required

  string

  The Maintenance Order Class

  Allowed values:
  • "Preventive"
  • "Corrective"
  • "Calibration"
  • "Inspection"
  • "Qualification"

  ScheduleClass

  required

  string

  The Maintenance Order schedule class that defines how it was triggered

  Allowed values:
  • "Time"
  • "Usage"
  • "TimeAndUsage"
  • "Manual"
  • "Risk"
  • "Condition"
  • "Predictive"

  ScheduledDate

  string

  format: date-time

  The DateTime when the Maintenance Order is scheduled to be performed

  ScheduleState

  string

  The Maintenance Order schedule state

  Allowed values:
  • "BeforeEarlyDue"
  • "EarlyDue"
  • "Due"
  • "LateDue"

  SystemState

  string

  The Maintenance Order System State

  Allowed values:
  • "Requested"
  • "Approved"
  • "Released"
  • "Completed"
  • "InProgress"
  • "WaitingForAcceptance"
  • "Canceled"
  • "Rejected"

  PlannedDuration

  number

  format: float

  The Maintenance Order planned duration in hours

  Examples values:
  • 0.5
  • 2

  StartDate

  string

  format: date-time

  The Maintenance Order start date

  EndDate

  string

  format: date-time

  The Maintenance Order end date

  TimeEarlyDue

  string

  format: date-time

  The Maintenance Order early due date for time-based Maintenance Orders

  TimeDue

  string

  format: date-time

  The Maintenance Order due date for time-based Maintenance Orders

  TimeLateDue

  string

  format: date-time

  The Maintenance Order late due date for time-based Maintenance Orders

  UsageEarlyDue

  number

  format: float

  The Maintenance Order early due date for usage-based Maintenance Orders

  Examples values:
  • 10

  UsageDue

  number

  format: float

  The Maintenance Order due date for usage-based Maintenance Orders

  Examples values:
  • 20

  UsageLateDue

  number

  format: float

  The Maintenance Order late due date for usage-based Maintenance Orders

  Examples values:
  • 35

  UsageCounter

  number

  format: float

  The Maintenance Order usage counter

  Examples values:
  • 0
  • 2

  UsageCounterClass

  string

  The Maintenance Order usage counter class

  Allowed values:
  • "Positive"
  • "Negative"

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Picture

  string

  The Entity picture

  Examples values:
  • "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"

  RequestedOn

  string

  format: date-time

  The DateTime when the Maintenance Order was requested

  Examples values:
  • "2025-02-11T18:14:30.013"

  RequestedBy

  string

  The user who has requested the Maintenance Order

  Examples values:
  • "2502120121100000001"

  Additional properties are allowed.

  Additional properties are allowed.

  Calendar

  Expand all

  object [Calendar Payload]

  Calendar information regarding the time of the event

  Calendar

  required

  string

  The calendar Name

  Examples values:
  • "CalendarName"
  • "Standard"

  CD

  required

  string

  format: date

  The event calendar day

  Examples values:
  • "2025-02-11T00:00:00"
  • "2025-02-11"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  TZToUTCInMin

  integer

  The timezone offset to UTC in minutes

  Examples values:
  • 0
  • 60

  FY

  required

  integer

  The event fiscal year

  Examples values:
  • 2025

  FQ

  required

  integer

  [ 1 .. 4 ]

  The event fiscal quarter

  FM

  required

  integer

  [ 1 .. 12 ]

  The event fiscal month

  FW

  required

  integer

  [ 1 .. 53 ]

  The event fiscal week

  Shift

  Expand all

  object [Shift Basic Payload]

  The event shift Basic information

  ShiftDefinitionName

  required

  string

  The event shift definition

  Examples values:
  • "Shift Definition Name"

  Name

  required

  string

  The event shift name

  Examples values:
  • "Shift 1"

  StartTime

  required

  string

  format: date-time

  The event shift start time

  Examples values:
  • "2025-02-18T18:00:00Z"

  EndTime

  required

  string

  format: date-time

  The event shift end time

  Examples values:
  • "2025-02-19T02:00:00Z"

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  object allOf

  The Basic Area information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Basic Area Payload:

  Expand all

  object [Basic Area Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Resource

  Expand all

  object allOf

  Consists of Resource Basic Payload:

  Expand all

  object allOf

  The Basic Resource information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Resource Basic Payload:

  Expand all

  object [Resource Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  ResourceType

  string

  The Resource Type

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  Additional properties are allowed.

  Additional properties are allowed.

  And of Maintenance Order Resource Payload:

  Expand all

  object [Maintenance Order Resource Payload]

  OpenCorrectiveMAOsCount

  integer

  >= 0

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #MaintenanceOrder

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "MaintenanceOrder",
        "Area",
        "Resource"
      ],
      "DataGroups": [
        [
          "2502181710210000001",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181712430124398",
          "2502181710210006855"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "MaintenanceOrder": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "UniversalState": "Active",
      "AssociatedWith": "Resource",
      "Class": "Preventive",
      "ScheduleClass": "Time",
      "ScheduledDate": "2019-08-24T14:15:22Z",
      "ScheduleState": "BeforeEarlyDue",
      "SystemState": "Requested",
      "PlannedDuration": 0.5,
      "StartDate": "2019-08-24T14:15:22Z",
      "EndDate": "2019-08-24T14:15:22Z",
      "TimeEarlyDue": "2019-08-24T14:15:22Z",
      "TimeDue": "2019-08-24T14:15:22Z",
      "TimeLateDue": "2019-08-24T14:15:22Z",
      "UsageEarlyDue": 10,
      "UsageDue": 20,
      "UsageLateDue": 35,
      "UsageCounter": 0,
      "UsageCounterClass": "Positive",
      "Type": "Standard",
      "Description": "Entity description",
      "Picture": "/api/GenericService/DownloadAttachment/2502130000050000003?open=true",
      "RequestedOn": "2025-02-11T18:14:30.013",
      "RequestedBy": "2502120121100000001"
    },
    "Calendar": {
      "Calendar": "CalendarName",
      "CD": "2025-02-11T00:00:00",
      "Timezone": "GMT Standard Time",
      "TZToUTCInMin": 0,
      "FY": 2025,
      "FQ": 1,
      "FM": 1,
      "FW": 1,
      "Shift": {
        "ShiftDefinitionName": "Shift Definition Name",
        "Name": "Shift 1",
        "StartTime": "2025-02-18T18:00:00Z",
        "EndTime": "2025-02-19T02:00:00Z"
      }
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "ResourceType": "Standard",
      "Position": 0,
      "Model": "SX1",
      "OpenCorrectiveMAOsCount": 0
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Material_MaterialDefects

  The topic on which material defects events may be produced and consumed

  Operation IDMaterialDefects

  Accepts the following message:

  Material DefectsMaterialDefectsEvent

  Inform about a quantity change of a particular material

  • application/json

  Message IDMaterialDefectsEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Defect,Material,Area,Resource,Step,Product,ProductGroup,PartNumber]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Material Defects:

  Expand all

  object [Material Defects]

  Defect

  Expand all

  required

  object allOf

  The Material Defect information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Material Defect Payload:

  Expand all

  object [Material Defect Payload]

  CorrelationId

  required

  string

  Examples values:
  • "127b64a9b47f46df40777e4b2029db54"

  State

  required

  string

  Examples values:
  • "Open"

  Reason

  required

  string

  Examples values:
  • "Reason A"

  ScrapReason

  string

  Examples values:
  • "Reason B"

  OpenDate

  string

  format: date-time

  Examples values:
  • "2025-02-11T20:28:08.353"

  OpenRemark

  string

  Examples values:
  • "Remark edited"

  ClosedDate

  string

  format: date-time

  Examples values:
  • "2025-02-12T20:28:08.353"

  CloseRemark

  string

  Examples values:
  • "Accept the Defect"

  ReferenceDesignator

  string

  Examples values:
  • "C28 C30 C36 C44 C53 C82"

  PinNumber

  string

  Examples values:
  • "ABCD"

  RepairAction

  string

  Examples values:
  • "Repair Required"
  • "Can be fixed without replacing nothing by welding it, but can also be replaced"

  ReplacementMaterial

  string

  Examples values:
  • "Material Name"

  SubMaterial

  string

  Examples values:
  • "Material Name"

  Location

  string

  Examples values:
  • "(-5, -5)"
  • "(226.667, 54)"

  Additional properties are allowed.

  Additional properties are allowed.

  Material

  Expand all

  required

  object allOf

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Material Basic Payload:

  Expand all

  object [Material Basic Payload]

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  string

  The form of the material.

  Examples values:
  • "Batch"

  FlowPath

  string

  The flow path of the material in the process.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material.

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  required

  object allOf

  The Basic Area information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Basic Area Payload:

  Expand all

  object [Basic Area Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Resource

  Expand all

  object allOf

  The Basic Resource information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Resource Basic Payload:

  Expand all

  object [Resource Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  ResourceType

  string

  The Resource Type

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  required

  object allOf

  The Basic Step information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  required

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Calendar

  Expand all

  object [Calendar Payload]

  Calendar information regarding the time of the event

  Calendar

  required

  string

  The calendar Name

  Examples values:
  • "CalendarName"
  • "Standard"

  CD

  required

  string

  format: date

  The event calendar day

  Examples values:
  • "2025-02-11T00:00:00"
  • "2025-02-11"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  TZToUTCInMin

  integer

  The timezone offset to UTC in minutes

  Examples values:
  • 0
  • 60

  FY

  required

  integer

  The event fiscal year

  Examples values:
  • 2025

  FQ

  required

  integer

  [ 1 .. 4 ]

  The event fiscal quarter

  FM

  required

  integer

  [ 1 .. 12 ]

  The event fiscal month

  FW

  required

  integer

  [ 1 .. 53 ]

  The event fiscal week

  Shift

  Expand all

  object [Shift Basic Payload]

  The event shift Basic information

  ShiftDefinitionName

  required

  string

  The event shift definition

  Examples values:
  • "Shift Definition Name"

  Name

  required

  string

  The event shift name

  Examples values:
  • "Shift 1"

  StartTime

  required

  string

  format: date-time

  The event shift start time

  Examples values:
  • "2025-02-18T18:00:00Z"

  EndTime

  required

  string

  format: date-time

  The event shift end time

  Examples values:
  • "2025-02-19T02:00:00Z"

  Additional properties are allowed.

  Additional properties are allowed.

  PartNumber

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  • #Material

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Defect",
        "Material",
        "Area",
        "Resource",
        "Step",
        "Product",
        "ProductGroup",
        "PartNumber"
      ],
      "DataGroups": [
        [
          "2502181710210000001",
          "-1",
          "-1",
          "-1",
          "-1",
          "2502112314355655001",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181712430124398",
          "2502181710210006855"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Defect": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "CorrelationId": "127b64a9b47f46df40777e4b2029db54",
      "State": "Open",
      "Reason": "Reason A",
      "ScrapReason": "Reason B",
      "OpenDate": "2025-02-11T20:28:08.353",
      "OpenRemark": "Remark edited",
      "ClosedDate": "2025-02-12T20:28:08.353",
      "CloseRemark": "Accept the Defect",
      "ReferenceDesignator": "C28 C30 C36 C44 C53 C82",
      "PinNumber": "ABCD",
      "RepairAction": "Repair Required",
      "ReplacementMaterial": "Material Name",
      "SubMaterial": "Material Name",
      "Location": "(-5, -5)"
    },
    "Material": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "ResourceType": "Standard",
      "Position": 0,
      "Model": "SX1"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "ProductGroup": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "Calendar": {
      "Calendar": "CalendarName",
      "CD": "2025-02-11T00:00:00",
      "Timezone": "GMT Standard Time",
      "TZToUTCInMin": 0,
      "FY": 2025,
      "FQ": 1,
      "FM": 1,
      "FW": 1,
      "Shift": {
        "ShiftDefinitionName": "Shift Definition Name",
        "Name": "Shift 1",
        "StartTime": "2025-02-18T18:00:00Z",
        "EndTime": "2025-02-19T02:00:00Z"
      }
    },
    "PartNumber": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Material_MaterialGenealogy

  The topic on which all material genealogy operations may be produced and consumed

  Operation IDMaterialGenealogy

  Accepts the following message:

  Material GenealogyMaterialGenealogyEvent

  Inform about a Genealogy operation of a particular material

  • application/json

  Message IDMaterialGenealogyEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Material Genealogy:

  Expand all

  object [Material Genealogy]

  SourceMaterials

  Expand all

  required

  array<allOf>

  >= 1

  Items:

  allOf

  Consists of Material Genealogy Payload:

  Expand all

  object allOf

  The Material Genealogy information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Material Genealogy Payload:

  Expand all

  object [Material Genealogy Payload]

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  DateEnteredStep

  string

  format: date-time

  The Date when the Source Material entered the Step

  Examples values:
  • "2021-08-24T14:15:22Z"

  Location

  string

  A user or application defined source location

  PrimaryQuantityBefore

  number

  format: float

  Changes on Primary Quantity

  PrimaryQuantityAfter

  number

  format: float

  Changes on Primary Quantity

  PrimaryUnits

  string

  Primary Units Of Measure

  AssembledPrimaryQuantity

  number

  format: float

  Assembled Primary Quantity

  SecondaryQuantityBefore

  number

  format: float

  Changes on Secondary Quantity

  SecondaryQuantityAfter

  number

  format: float

  Changes on Secondary Quantity

  SecondaryUnits

  string

  Secondary Units Of Measure

  AssembledSecondaryQuantity

  number

  format: float

  Assembled Secondary Quantity

  SubMaterialsPrimaryQuantityBefore

  number

  format: float

  Changes on Primary Quantity

  SubMaterialsPrimaryQuantityAfter

  number

  format: float

  Changes on Primary Quantity

  SubMaterialsPrimaryUnits

  string

  Primary Units Of Measure

  SubMaterialsSecondaryQuantityBefore

  number

  format: float

  Changes on Secondary Quantity

  SubMaterialsSecondaryQuantityAfter

  number

  format: float

  Changes on Secondary Quantity

  SubMaterialsSecondaryUnits

  string

  Secondary Units Of Measure

  FlowPath

  string

  The FlowPath where the Source Material was at the time of the Genealogy Change

  Flow

  Expand all

  object allOf

  The Flow information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Resource

  Expand all

  allOf

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of DisplayOrder:

  Expand all

  object [DisplayOrder]

  DisplayOrder

  integer

  The Resource DisplayOrder

  Additional properties are allowed.

  Area

  Expand all

  allOf

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of DisplayOrder:

  Expand all

  object [DisplayOrder]

  DisplayOrder

  integer

  The Area DisplayOrder

  Additional properties are allowed.

  ParentResource

  Expand all

  allOf

  Consists of Resource Basic Payload:

  Expand all

  object allOf

  The Basic Resource information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Resource Basic Payload:

  Expand all

  object [Resource Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  ResourceType

  string

  The Resource Type

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  Additional properties are allowed.

  Additional properties are allowed.

  And of DisplayOrder:

  Expand all

  object [DisplayOrder]

  DisplayOrder

  integer

  The ParentResource DisplayOrder

  Additional properties are allowed.

  ParentMaterial

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  ProductionOrder

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Product

  Expand all

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Operation

  required

  string

  Unique identifier across all of the instances of the same type

  Allowed values:
  • "Split"
  • "Merge"
  • "Assemble"
  • "AutomaticAssemble"
  • "AssembleReplace"
  • "Disassemble"
  • "Expand"
  • "Collapse"
  • "CreateSubProducts"
  • "Grade"
  • "SplitByProduct"
  • "Compose or Combine"

  IdentifierMaterial

  required

  string

  UID of the Material used as one of the keys for this operation

  OperationDate

  required

  string

  format: date-time

  The event timestamp

  OperationId

  required

  string

  Unique identifier across all of the operations

  OperationComment

  string

  The event comment

  BillOfMaterials

  Expand all

  object allOf

  The Bill Of Materials information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  TargetMaterials

  Expand all

  required

  array<object allOf>

  >= 1

  Items:

  object allOf

  The Material Genealogy information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Material Genealogy Payload:

  Expand all

  object [Material Genealogy Payload]

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  DateEnteredStep

  string

  format: date-time

  The Date when the Source Material entered the Step

  Examples values:
  • "2021-08-24T14:15:22Z"

  Location

  string

  A user or application defined source location

  PrimaryQuantityBefore

  number

  format: float

  Changes on Primary Quantity

  PrimaryQuantityAfter

  number

  format: float

  Changes on Primary Quantity

  PrimaryUnits

  string

  Primary Units Of Measure

  AssembledPrimaryQuantity

  number

  format: float

  Assembled Primary Quantity

  SecondaryQuantityBefore

  number

  format: float

  Changes on Secondary Quantity

  SecondaryQuantityAfter

  number

  format: float

  Changes on Secondary Quantity

  SecondaryUnits

  string

  Secondary Units Of Measure

  AssembledSecondaryQuantity

  number

  format: float

  Assembled Secondary Quantity

  SubMaterialsPrimaryQuantityBefore

  number

  format: float

  Changes on Primary Quantity

  SubMaterialsPrimaryQuantityAfter

  number

  format: float

  Changes on Primary Quantity

  SubMaterialsPrimaryUnits

  string

  Primary Units Of Measure

  SubMaterialsSecondaryQuantityBefore

  number

  format: float

  Changes on Secondary Quantity

  SubMaterialsSecondaryQuantityAfter

  number

  format: float

  Changes on Secondary Quantity

  SubMaterialsSecondaryUnits

  string

  Secondary Units Of Measure

  FlowPath

  string

  The FlowPath where the Source Material was at the time of the Genealogy Change

  Flow

  Expand all

  object allOf

  The Flow information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Resource

  Expand all

  allOf

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of DisplayOrder:

  Expand all

  object [DisplayOrder]

  DisplayOrder

  integer

  The Resource DisplayOrder

  Additional properties are allowed.

  Area

  Expand all

  allOf

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of DisplayOrder:

  Expand all

  object [DisplayOrder]

  DisplayOrder

  integer

  The Area DisplayOrder

  Additional properties are allowed.

  ParentResource

  Expand all

  allOf

  Consists of Resource Basic Payload:

  Expand all

  object allOf

  The Basic Resource information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Resource Basic Payload:

  Expand all

  object [Resource Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  ResourceType

  string

  The Resource Type

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  Additional properties are allowed.

  Additional properties are allowed.

  And of DisplayOrder:

  Expand all

  object [DisplayOrder]

  DisplayOrder

  integer

  The ParentResource DisplayOrder

  Additional properties are allowed.

  ParentMaterial

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  ProductionOrder

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Product

  Expand all

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility"
      ],
      "DataGroups": [
        [
          "2502181710210000001",
          "-1",
          "-1"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "SourceMaterials": [
      {
        "UID": "2502130212590000467",
        "Name": "Name",
        "UniversalState": "Active",
        "DateEnteredStep": "2021-08-24T14:15:22Z",
        "Location": "string",
        "PrimaryQuantityBefore": 0.1,
        "PrimaryQuantityAfter": 0.1,
        "PrimaryUnits": "string",
        "AssembledPrimaryQuantity": 0.1,
        "SecondaryQuantityBefore": 0.1,
        "SecondaryQuantityAfter": 0.1,
        "SecondaryUnits": "string",
        "AssembledSecondaryQuantity": 0.1,
        "SubMaterialsPrimaryQuantityBefore": 0.1,
        "SubMaterialsPrimaryQuantityAfter": 0.1,
        "SubMaterialsPrimaryUnits": "string",
        "SubMaterialsSecondaryQuantityBefore": 0.1,
        "SubMaterialsSecondaryQuantityAfter": 0.1,
        "SubMaterialsSecondaryUnits": "string",
        "FlowPath": "string",
        "Flow": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1"
        },
        "Step": {
          "UID": "2502130212590000467",
          "Name": "Name"
        },
        "Resource": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "DisplayOrder": 0
        },
        "Area": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "DisplayOrder": 0
        },
        "ParentResource": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "DisplayOrder": 0,
          "ResourceType": "Standard",
          "Position": 0,
          "Model": "SX1"
        },
        "ParentMaterial": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1"
        },
        "ProductionOrder": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1"
        },
        "Product": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1",
          "Type": "Standard",
          "Description": "Entity description"
        },
        "ProductGroup": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1",
          "Type": "Standard"
        }
      }
    ],
    "Operation": "Split",
    "IdentifierMaterial": "string",
    "OperationDate": "2019-08-24T14:15:22Z",
    "OperationId": "string",
    "OperationComment": "string",
    "BillOfMaterials": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "TargetMaterials": [
      {
        "UID": "2502130212590000467",
        "Name": "Name",
        "UniversalState": "Active",
        "DateEnteredStep": "2021-08-24T14:15:22Z",
        "Location": "string",
        "PrimaryQuantityBefore": 0.1,
        "PrimaryQuantityAfter": 0.1,
        "PrimaryUnits": "string",
        "AssembledPrimaryQuantity": 0.1,
        "SecondaryQuantityBefore": 0.1,
        "SecondaryQuantityAfter": 0.1,
        "SecondaryUnits": "string",
        "AssembledSecondaryQuantity": 0.1,
        "SubMaterialsPrimaryQuantityBefore": 0.1,
        "SubMaterialsPrimaryQuantityAfter": 0.1,
        "SubMaterialsPrimaryUnits": "string",
        "SubMaterialsSecondaryQuantityBefore": 0.1,
        "SubMaterialsSecondaryQuantityAfter": 0.1,
        "SubMaterialsSecondaryUnits": "string",
        "FlowPath": "string",
        "Flow": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1"
        },
        "Step": {
          "UID": "2502130212590000467",
          "Name": "Name"
        },
        "Resource": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "DisplayOrder": 0
        },
        "Area": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "DisplayOrder": 0
        },
        "ParentResource": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "DisplayOrder": 0,
          "ResourceType": "Standard",
          "Position": 0,
          "Model": "SX1"
        },
        "ParentMaterial": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1"
        },
        "ProductionOrder": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1"
        },
        "Product": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1",
          "Type": "Standard",
          "Description": "Entity description"
        },
        "ProductGroup": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1",
          "Type": "Standard"
        }
      }
    ]
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Material_MaterialOperations

  The topic on which all material operations may be produced and consumed

  Operation IDMaterialOperations

  • #LightVariant

  Accepts the following message:

  Move MaterialMaterialOperationsEvent

  Inform about a movement of a particular material

  • application/json

  Message IDMaterialOperationsEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId). Also included in the light event variant.

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event. Also included in the light event variant.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction. Also included in the light event variant.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM. Also included in the light event variant.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction. Also included in the light event variant.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Material,ParentMaterial,Area,Resource,ParentResource,Flow,Step,Product,ProductGroup,ProductionOrder,Employee]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Payload:

  Expand all

  object [Site Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Move Material:

  Expand all

  object [Move Material]

  Material

  Expand all

  required

  allOf

  Consists of Material Payload:

  Expand all

  object allOf

  The Material information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity. Also included in the light event variant.

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity. Also included in the light event variant.

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Material Full Payload:

  Expand all

  object [Material Full Payload]

  Type

  required

  string

  The Entity type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Process"

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step. Also included in the light event variant.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  required

  string

  The form of the material. Also included in the light event variant.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process. Also included in the light event variant.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material. Also included in the light event variant.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material. Also included in the light event variant.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material. Also included in the light event variant.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material. Also included in the light event variant.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material. Also included in the light event variant.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material. Also included in the light event variant.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material. Also included in the light event variant.

  ProcessingState

  string

  Material Processing States.

  Allowed values:
  • "Queued"
  • "Dispatched"
  • "InProcess"
  • "Processed"
  • "InTransit"

  ReworkCount

  integer

  >= 0

  The number of times the material has been reworked. Also included in the light event variant.

  HoldCount

  integer

  >= 0

  The number of times the material has been reworked. Also included in the light event variant.

  Additional properties are allowed.

  Additional properties are allowed.

  And of The Material Cycle Time information:

  Expand all

  object [The Material Cycle Time information]

  IdealTimePerUnitInSecs

  number

  format: float

  Examples values:
  • 50

  ReferenceTimePerUnitInSecs

  number

  format: float

  Examples values:
  • 55.5

  DateEnteredFacility

  string

  format: date-time

  The date and time when the material entered the facility. Also included in the light event variant.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Additional properties are allowed.

  ParentMaterial

  Expand all

  object allOf

  The Material information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Material Full Payload:

  Expand all

  object [Material Full Payload]

  Type

  required

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  required

  string

  The form of the material.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material.

  ProcessingState

  string

  Material Processing States

  Allowed values:
  • "Queued"
  • "Dispatched"
  • "InProcess"
  • "Processed"
  • "InTransit"

  ReworkCount

  integer

  >= 0

  HoldCount

  integer

  >= 0

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  required

  object allOf

  The Area Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Area Basic Payload:

  Expand all

  object [Area Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type.

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Resource

  Expand all

  object allOf

  The Basic Resource information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Resource Basic Payload:

  Expand all

  object [Resource Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  ResourceType

  string

  The Resource Type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model. Also included in the light event variant.

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  Additional properties are allowed.

  Additional properties are allowed.

  ParentResource

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Flow

  Expand all

  required

  object allOf

  The Full Step information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object. Also included in the light event variant.

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object. Also included in the light event variant.

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Flow Payload:

  Expand all

  object [Flow Payload]

  Type

  string

  The Entity type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  required

  object allOf

  The Basic Step information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  required

  object allOf

  The Full Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object. Also included in the light event variant.

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object. Also included in the light event variant.

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductionOrder

  Expand all

  object allOf

  The Production Order Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Production Order Basic Payload:

  Expand all

  object [Production Order Basic Payload]

  Quantity

  required

  number

  format: float

  Examples values:
  • 11

  Units

  required

  string

  Examples values:
  • "Chocolates"

  DueDate

  required

  string

  format: date-time

  Examples values:
  • "2025-02-26T11:27:11.487"

  PlannedStartDate

  string

  format: date-time

  Examples values:
  • "2025-02-14T16:28:57.160"

  PlannedEndDate

  string

  format: date-time

  Examples values:
  • "2025-02-18T16:28:57.160"

  OrderNumber

  string

  Examples values:
  • "OrderNumber"

  Additional properties are allowed.

  Additional properties are allowed.

  Calendar

  Expand all

  object [Calendar Payload]

  Calendar information regarding the time of the event

  Calendar

  required

  string

  The calendar Name

  Examples values:
  • "CalendarName"
  • "Standard"

  CD

  required

  string

  format: date

  The event calendar day

  Examples values:
  • "2025-02-11T00:00:00"
  • "2025-02-11"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  TZToUTCInMin

  integer

  The timezone offset to UTC in minutes

  Examples values:
  • 0
  • 60

  FY

  required

  integer

  The event fiscal year

  Examples values:
  • 2025

  FQ

  required

  integer

  [ 1 .. 4 ]

  The event fiscal quarter

  FM

  required

  integer

  [ 1 .. 12 ]

  The event fiscal month

  FW

  required

  integer

  [ 1 .. 53 ]

  The event fiscal week

  Shift

  Expand all

  object [Shift Basic Payload]

  The event shift Basic information

  ShiftDefinitionName

  required

  string

  The event shift definition

  Examples values:
  • "Shift Definition Name"

  Name

  required

  string

  The event shift name

  Examples values:
  • "Shift 1"

  StartTime

  required

  string

  format: date-time

  The event shift start time

  Examples values:
  • "2025-02-18T18:00:00Z"

  EndTime

  required

  string

  format: date-time

  The event shift end time

  Examples values:
  • "2025-02-19T02:00:00Z"

  Additional properties are allowed.

  Additional properties are allowed.

  DataCollection

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  BillOfMaterials

  Expand all

  object allOf

  The Bill Of Materials information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  BillOfTools

  Expand all

  object allOf

  The Bill Of Tools information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Recipe

  Expand all

  object allOf

  The Recipe information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Employee

  Expand all

  object allOf

  The Employee information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Employee Payload:

  Expand all

  object [Employee Payload]

  Number

  string

  The employee number

  Examples values:
  • "Employee 001"

  Team

  string

  The employee team

  Examples values:
  • "Team A"

  Additional properties are allowed.

  Additional properties are allowed.

  Attributes

  Expand all

  object [Attributes Payload]

  Attributes Information

  Names

  Expand all

  required

  array<string>

  Names Array

  Examples values:
  • [LossClassificationName1,LossClassificationName2,LossClassificationValue1,LossClassificationValue2,LossReason,PrimaryQuantityLoss]

  Items:

  string

  Values

  Expand all

  required

  array<string>

  Values Array

  Examples values:
  • [YieldGroup,RootCause,0195,01,CU14 - Copper void on copper ground,1]

  Items:

  string

  Additional properties are allowed.

  Comments

  string

  Material Notes

  Examples values:
  • "Comments"

  Previous

  Expand all

  object allOf

  The Previous Material information (introduced in CDM v11.2.0)

  Consists of Previous Material Payload:

  Expand all

  object [Previous Material Payload]

  Step

  Expand all

  object allOf

  The Basic Step information (introduced in CDM v11.2.0)

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  Material

  Expand all

  object [Previous Material Payload]

  The Previous Material information (introduced in CDM v11.2.0)

  DateEnteredFacility

  string

  format: date-time

  The date and time when the material entered the facility. Also included in the light event variant.

  Examples values:
  • "2025-02-11T20:28:06.333"

  DateEnteredStep

  string

  format: date-time

  The date and time when the material entered the current step. Also included in the light event variant.

  Examples values:
  • "2025-02-11T20:28:06.333"

  PrimaryQty

  number

  format: float>= 0

  The primary quantity of the material. Also included in the light event variant.

  Examples values:
  • 10

  PrimaryUnits

  string

  The primary units of the material. Also included in the light event variant.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material. Also included in the light event variant.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material. Also included in the light event variant.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material. Also included in the light event variant.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material. Also included in the light event variant.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material. Also included in the light event variant.

  Form

  string

  The form of the material. Also included in the light event variant.

  Examples values:
  • "Batch"

  FlowPath

  string

  The flow path of the material in the process. Also included in the light event variant.

  Examples values:
  • "FlowName:A:1/StepName:1"

  ReworkCount

  integer

  >= 0

  The number of times the material has been reworked. Also included in the light event variant.

  HoldCount

  integer

  >= 0

  The number of times the material has been reworked. Also included in the light event variant.

  Additional properties are allowed.

  Product

  Expand all

  object allOf

  The Previous Product information (introduced in CDM v11.2.0)

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object. Also included in the light event variant.

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object. Also included in the light event variant.

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Flow

  Expand all

  object allOf

  The Previous Flow information (introduced in CDM v11.2.0)

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object. Also included in the light event variant.

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object. Also included in the light event variant.

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Flow Payload:

  Expand all

  object [Flow Payload]

  Type

  string

  The Entity type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  object allOf

  The Previous Area information (introduced in CDM v11.2.0)

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Tools

  Expand all

  array<allOf>

  List of tools used during the material operation.

  Examples values:
  • {"UID":"2505121203180000010","Name":"Mixing Tool","Type":"Standard","Position":0}
  • {"UID":"2505121203180000011","Name":"Heating Tool","Type":"Standard","Position":2}

  Items:

  allOf

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Tools:

  Expand all

  object [Tools]

  Tools Payload

  Type

  string

  The tool type.

  Examples values:
  • "Standard"

  Position

  integer

  The postion of the tool.

  Examples values:
  • 1

  Additional properties are allowed.

  Additional properties are allowed.

  • #Material, LightVariant

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Material",
        "ParentMaterial",
        "Area",
        "Resource",
        "ParentResource",
        "Flow",
        "Step",
        "Product",
        "ProductGroup",
        "ProductionOrder",
        "Employee"
      ],
      "DataGroups": [
        [
          "2502181710210000004",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181712430124399",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "-1",
          "-1",
          "-1",
          "2502181712430124398",
          "1234546671021000685"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Material": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "Type": "Standard",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0,
      "ProcessingState": "Queued",
      "ReworkCount": 0,
      "HoldCount": 0,
      "IdealTimePerUnitInSecs": 50,
      "ReferenceTimePerUnitInSecs": 55.5,
      "DateEnteredFacility": "2025-02-11T20:28:06.333"
    },
    "ParentMaterial": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "Type": "Standard",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0,
      "ProcessingState": "Queued",
      "ReworkCount": 0,
      "HoldCount": 0
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "ResourceType": "Standard",
      "Position": 0,
      "Model": "SX1",
      "Service": "ComplexDispatchAndTrackInMaterial"
    },
    "ParentResource": {
      "UID": "2502130212590000467",
      "Name": "Name"
    },
    "Flow": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "ProductGroup": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "ProductionOrder": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Quantity": 11,
      "Units": "Chocolates",
      "DueDate": "2025-02-26T11:27:11.487",
      "PlannedStartDate": "2025-02-14T16:28:57.160",
      "PlannedEndDate": "2025-02-18T16:28:57.160",
      "OrderNumber": "OrderNumber"
    },
    "Calendar": {
      "Calendar": "CalendarName",
      "CD": "2025-02-11T00:00:00",
      "Timezone": "GMT Standard Time",
      "TZToUTCInMin": 0,
      "FY": 2025,
      "FQ": 1,
      "FM": 1,
      "FW": 1,
      "Shift": {
        "ShiftDefinitionName": "Shift Definition Name",
        "Name": "Shift 1",
        "StartTime": "2025-02-18T18:00:00Z",
        "EndTime": "2025-02-19T02:00:00Z"
      }
    },
    "DataCollection": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "BillOfMaterials": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "BillOfTools": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Recipe": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Employee": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Number": "Employee 001",
      "Team": "Team A"
    },
    "Attributes": {
      "Names": [
        "LossClassificationName1",
        "LossClassificationName2",
        "LossClassificationValue1",
        "LossClassificationValue2",
        "LossReason",
        "PrimaryQuantityLoss"
      ],
      "Values": [
        "YieldGroup",
        "RootCause",
        "0195",
        "01",
        "CU14 - Copper void on copper ground",
        "1"
      ]
    },
    "Comments": "Comments",
    "Previous": {
      "Step": {
        "UID": "2502130212590000467",
        "Name": "Name"
      },
      "Material": {
        "DateEnteredFacility": "2025-02-11T20:28:06.333",
        "DateEnteredStep": "2025-02-11T20:28:06.333",
        "PrimaryQty": 10,
        "PrimaryUnits": "UnitA",
        "SecondaryQty": 5,
        "SecondaryUnits": "UnitB",
        "SubMaterialsPrimaryQty": 2,
        "SubMaterialsSecondaryQty": 2,
        "SubMaterialCount": 0,
        "Form": "Batch",
        "FlowPath": "FlowName:A:1/StepName:1",
        "ReworkCount": 0,
        "HoldCount": 0
      },
      "Product": {
        "UID": "2502130212590000467",
        "Name": "Name",
        "MajorRevision": "A",
        "MinorRevision": "1",
        "Type": "Standard"
      },
      "Flow": {
        "UID": "2502130212590000467",
        "Name": "Name",
        "MajorRevision": "A",
        "MinorRevision": "1",
        "Type": "Standard"
      },
      "Area": {
        "UID": "2502130212590000467",
        "Name": "Name"
      }
    },
    "Tools": {
      "UID": "2505121203180000010",
      "Name": "Mixing Tool",
      "Type": "Standard",
      "Position": 0
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Material_ShipUnship

  The topic on which all material ship, receive, and Unship operations may be produced and consumed

  Operation IDShipUnship

  Accepts the following message:

  Material Ship/UnshipShipUnshipEvent

  Inform about ship, receive, and unship operations for a given material

  • application/json

  Message IDShipUnshipEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Material,Area,ToFacility,Flow,Step,Product,ProductGroup,ProductionOrder,Employee]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Ship Unship:

  Expand all

  object [Ship Unship]

  Material

  Expand all

  required

  object allOf

  The Material information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Material Full Payload:

  Expand all

  object [Material Full Payload]

  Type

  required

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  required

  string

  The form of the material.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material.

  ProcessingState

  string

  Material Processing States

  Allowed values:
  • "Queued"
  • "Dispatched"
  • "InProcess"
  • "Processed"
  • "InTransit"

  ReworkCount

  integer

  >= 0

  HoldCount

  integer

  >= 0

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  required

  object allOf

  The Basic Area information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Basic Area Payload:

  Expand all

  object [Basic Area Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Flow

  Expand all

  required

  object allOf

  The Flow information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  required

  object allOf

  The Basic Step information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  required

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductionOrder

  Expand all

  object allOf

  The Production Order Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Production Order Basic Payload:

  Expand all

  object [Production Order Basic Payload]

  Quantity

  required

  number

  format: float

  Examples values:
  • 11

  Units

  required

  string

  Examples values:
  • "Chocolates"

  DueDate

  required

  string

  format: date-time

  Examples values:
  • "2025-02-26T11:27:11.487"

  PlannedStartDate

  string

  format: date-time

  Examples values:
  • "2025-02-14T16:28:57.160"

  PlannedEndDate

  string

  format: date-time

  Examples values:
  • "2025-02-18T16:28:57.160"

  OrderNumber

  string

  Examples values:
  • "OrderNumber"

  Additional properties are allowed.

  Additional properties are allowed.

  Calendar

  Expand all

  object [Calendar Payload]

  Calendar information regarding the time of the event

  Calendar

  required

  string

  The calendar Name

  Examples values:
  • "CalendarName"
  • "Standard"

  CD

  required

  string

  format: date

  The event calendar day

  Examples values:
  • "2025-02-11T00:00:00"
  • "2025-02-11"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  TZToUTCInMin

  integer

  The timezone offset to UTC in minutes

  Examples values:
  • 0
  • 60

  FY

  required

  integer

  The event fiscal year

  Examples values:
  • 2025

  FQ

  required

  integer

  [ 1 .. 4 ]

  The event fiscal quarter

  FM

  required

  integer

  [ 1 .. 12 ]

  The event fiscal month

  FW

  required

  integer

  [ 1 .. 53 ]

  The event fiscal week

  Shift

  Expand all

  object [Shift Basic Payload]

  The event shift Basic information

  ShiftDefinitionName

  required

  string

  The event shift definition

  Examples values:
  • "Shift Definition Name"

  Name

  required

  string

  The event shift name

  Examples values:
  • "Shift 1"

  StartTime

  required

  string

  format: date-time

  The event shift start time

  Examples values:
  • "2025-02-18T18:00:00Z"

  EndTime

  required

  string

  format: date-time

  The event shift end time

  Examples values:
  • "2025-02-19T02:00:00Z"

  Additional properties are allowed.

  Additional properties are allowed.

  Employee

  Expand all

  object allOf

  The Employee information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Employee Payload:

  Expand all

  object [Employee Payload]

  Number

  string

  The employee number

  Examples values:
  • "Employee 001"

  Team

  string

  The employee team

  Examples values:
  • "Team A"

  Additional properties are allowed.

  Additional properties are allowed.

  ShippingLabel

  string

  Shipping label associated with the material

  ToFacility

  Expand all

  required

  object [To Facility]

  The Facility where the material will be shipped/unshipped

  UID

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  string

  Name of the object

  Examples values:
  • "Name"

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  MaterialHierarchy

  Expand all

  array<object>

  object

  Material

  Expand all

  required

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  ParentMaterial

  Expand all

  required

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #Material

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Material",
        "Area",
        "ToFacility",
        "Flow",
        "Step",
        "Product",
        "ProductGroup",
        "ProductionOrder",
        "Employee"
      ],
      "DataGroups": [
        [
          "-1",
          "-1",
          "2502181710210000001",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "2502181710210000211",
          "-1"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Material": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "Type": "Standard",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0,
      "ProcessingState": "Queued",
      "ReworkCount": 0,
      "HoldCount": 0
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Flow": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "ProductGroup": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "ProductionOrder": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Quantity": 11,
      "Units": "Chocolates",
      "DueDate": "2025-02-26T11:27:11.487",
      "PlannedStartDate": "2025-02-14T16:28:57.160",
      "PlannedEndDate": "2025-02-18T16:28:57.160",
      "OrderNumber": "OrderNumber"
    },
    "Calendar": {
      "Calendar": "CalendarName",
      "CD": "2025-02-11T00:00:00",
      "Timezone": "GMT Standard Time",
      "TZToUTCInMin": 0,
      "FY": 2025,
      "FQ": 1,
      "FM": 1,
      "FW": 1,
      "Shift": {
        "ShiftDefinitionName": "Shift Definition Name",
        "Name": "Shift 1",
        "StartTime": "2025-02-18T18:00:00Z",
        "EndTime": "2025-02-19T02:00:00Z"
      }
    },
    "Employee": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Number": "Employee 001",
      "Team": "Team A"
    },
    "ShippingLabel": "string",
    "ToFacility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "MaterialHierarchy": [
      {
        "Material": {
          "UID": "2502130212590000467",
          "Name": "Name"
        },
        "ParentMaterial": {
          "UID": "2502130212590000467",
          "Name": "Name"
        }
      }
    ]
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Production_ProductionCycleTimes

  The topic used for publishing and consuming all events related to production order cycle times

  Operation IDProductionCycleTimes

  Accepts the following message:

  ProductionCycleTimesEvent

  Provides detailed reports on production cycle times

  • application/json

  Message IDProductionCycleTimesEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Material,Area,Flow,Step,Product,ProductGroup,ProductionOrder]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Production Cycle Times:

  Expand all

  object [Production Cycle Times]

  Flow

  Expand all

  object allOf

  The Flow information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  required

  object allOf

  The Basic Step information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Yield

  required

  number

  Percentage of good units produced relative to the total units started in production

  CycleTimeScale

  required

  string

  Unit of measurement used for cycle time (e.g., seconds, minutes, hours)

  FixedCycleTime

  required

  number

  Constant portion of the cycle time that does not vary with production volume

  VariableCycleTime

  required

  number

  Portion of the cycle time that scales with the number of units produced

  Additional properties are allowed.

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Material",
        "Area",
        "Flow",
        "Step",
        "Product",
        "ProductGroup",
        "ProductionOrder"
      ],
      "DataGroups": [
        [
          "2502181710210000004",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "-1",
          "2502181712430124398"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Flow": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "ProductGroup": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "Yield": 0,
    "CycleTimeScale": "string",
    "FixedCycleTime": 0,
    "VariableCycleTime": 0
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Production_ProductionOrder

  The topic on which all production order events may be produced and consumed

  Operation IDProductionOrder

  Accepts the following message:

  Production OrderProductionOrderEvent

  • application/json

  Message IDProductionOrderEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,ProductionOrder,Product,ProductGroup,Flow,Step,Customer]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Production Order:

  Expand all

  object [Production Order]

  ProductionOrder

  Expand all

  required

  object allOf

  The Production Order Full information

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Production Order Full Payload:

  Expand all

  object [Production Order Full Payload]

  Quantity

  required

  number

  format: float

  Examples values:
  • 11

  Units

  required

  string

  Examples values:
  • "Chocolates"

  DueDate

  required

  string

  format: date-time

  Examples values:
  • "2025-02-26T11:27:11.487"

  PlannedStartDate

  string

  format: date-time

  Examples values:
  • "2025-02-14T16:28:57.160"

  PlannedEndDate

  string

  format: date-time

  Examples values:
  • "2025-02-18T16:28:57.160"

  OrderNumber

  string

  Examples values:
  • "OrderNumber"

  OrderLine

  string

  Examples values:
  • "OrderLine"

  SystemState

  string

  Allowed values:
  • "Created"
  • "Released"
  • "InProgress"
  • "Completed"
  • "Closed"
  • "Canceled"

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  ActiveMaterialsCount

  integer

  >= 0

  MaterialsInProgressCount

  integer

  >= 0

  MaterialsCompletedCount

  integer

  >= 0

  MaterialsDeliveredCount

  integer

  >= 0

  InProgressQuantity

  number

  format: float>= 0

  CompletedQuantity

  number

  format: float>= 0

  DeliveredQuantity

  number

  format: float>= 0

  Comment

  string

  Examples values:
  • "A comment"

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  required

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  ProductGroup

  Expand all

  object allOf

  The Product Group information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Payload:

  Expand all

  object [Product Group Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Flow

  Expand all

  object allOf

  The Flow information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  Step

  Expand all

  object allOf

  The Basic Step information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Customer

  Expand all

  object allOf

  The Customer information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #ProductionOrder

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "ProductionOrder",
        "Product",
        "ProductGroup",
        "Flow",
        "Step",
        "Customer"
      ],
      "DataGroups": [
        [
          "2502181712430124399",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "-1",
          "-1",
          "2502181712430124398",
          "2502181710210006855"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "ProductionOrder": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "Quantity": 11,
      "Units": "Chocolates",
      "DueDate": "2025-02-26T11:27:11.487",
      "PlannedStartDate": "2025-02-14T16:28:57.160",
      "PlannedEndDate": "2025-02-18T16:28:57.160",
      "OrderNumber": "OrderNumber",
      "OrderLine": "OrderLine",
      "SystemState": "Created",
      "Type": "Standard",
      "Description": "Entity description",
      "ActiveMaterialsCount": 0,
      "MaterialsInProgressCount": 0,
      "MaterialsCompletedCount": 0,
      "MaterialsDeliveredCount": 0,
      "InProgressQuantity": 0.1,
      "CompletedQuantity": 0.1,
      "DeliveredQuantity": 0.1,
      "Comment": "A comment"
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "ProductGroup": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard"
    },
    "Flow": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Customer": {
      "UID": "2502130212590000467",
      "Name": "Name"
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Production_ProductionPlans

  The topic on which all production plans events may be produced and consumed

  Operation IDProductionPlans

  Accepts the following message:

  ProductionPlansEvent

  Provides detailed reports on production plans

  • application/json

  Message IDProductionPlansEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Area,Plan]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Production Plans:

  Expand all

  object [Production Plans]

  Area

  Expand all

  required

  object allOf

  The Basic Area information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Basic Area Payload:

  Expand all

  object [Basic Area Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Plan

  Expand all

  required

  object allOf

  Plan information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Plan Payload:

  Expand all

  object [Plan Payload]

  ManufacturingLevel

  required

  string

  The hierarchical level to which the plan applies

  Examples values:
  • "Area"
  • "Enterprise"
  • "Facility"
  • "Site"

  Applicability

  required

  string

  Applicability condition or scope of the plan

  Examples values:
  • "All Shifts"

  Level

  required

  string

  Planning level of the plan

  Examples values:
  • "Product"
  • "Product Group"

  TimeUnit

  required

  string

  Time unit used in the plan

  Examples values:
  • "Day"
  • "Month"
  • "Shift"
  • "Week"

  PlanningHorizon

  required

  integer

  Duration of the planning horizon

  Examples values:
  • 168

  FrozenPeriod

  required

  integer

  Duration of the frozen period

  Examples values:
  • 24

  FromDate

  required

  string

  format: date-time

  Start date of the plan

  Examples values:
  • "2025-07-22T00:00:00Z"

  ToDate

  required

  string

  format: date-time

  End date of the plan

  Examples values:
  • "2025-07-29T00:00:00Z"

  Additional properties are allowed.

  Additional properties are allowed.

  PlanSteps

  Expand all

  allOf

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of PlanSteps:

  Expand all

  object [PlanSteps]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  DataGroup

  string

  Data group of the plan step.

  Examples values:
  • "NoAccess"
  • "AdminAccess"

  Additional properties are allowed.

  Calendar

  Expand all

  required

  allOf

  Consists of Base Object Payload:

  Expand all

  object [Base Object Payload]

  Information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  And of Calendar:

  Expand all

  object [Calendar]

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  Additional properties are allowed.

  ProductPlannedVolume

  Expand all

  array<allOf>

  Items:

  allOf

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Planned Volume:

  Expand all

  object [Product Planned Volume]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The description of the property.

  DataGroup

  string

  Data group of the product.

  Examples values:
  • "NoAccess"
  • "AdminAccess"

  PlannedVolume

  required

  number

  The planned volume of the product.

  Examples values:
  • "8.1"
  • "12.3"

  Additional properties are allowed.

  ProductGroupPlannedVolume

  Expand all

  array<allOf>

  Items:

  allOf

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Group Planned Volume:

  Expand all

  object [Product Group Planned Volume]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  DataGroup

  string

  Data group of the product group

  Examples values:
  • "NoAccess"
  • "AdminAccess"

  PlannedVolume

  required

  number

  The planned volume of the product group

  Examples values:
  • "8.1"
  • "12.3"

  Additional properties are allowed.

  ExcludedMaterialTypes

  Expand all

  array<object>

  object

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Area",
        "Plan"
      ],
      "DataGroups": [
        [
          "2502181710210000004",
          "2502181710210001231",
          "-1",
          "2502181710210006855",
          "2502181712430124398"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Plan": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "ManufacturingLevel": "Area",
      "Applicability": "All Shifts",
      "Level": "Product",
      "TimeUnit": "Day",
      "PlanningHorizon": 168,
      "FrozenPeriod": 24,
      "FromDate": "2025-07-22T00:00:00Z",
      "ToDate": "2025-07-29T00:00:00Z"
    },
    "PlanSteps": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Type": "Standard",
      "DisplayOrder": 1,
      "DataGroup": "NoAccess"
    },
    "Calendar": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "UniversalState": "Active",
      "Timezone": "GMT Standard Time"
    },
    "ProductPlannedVolume": [
      {
        "UID": "2502130212590000467",
        "Name": "Name",
        "MajorRevision": "A",
        "MinorRevision": "1",
        "Type": "Standard",
        "Description": "string",
        "DataGroup": "NoAccess",
        "PlannedVolume": "8.1"
      }
    ],
    "ProductGroupPlannedVolume": [
      {
        "UID": "2502130212590000467",
        "Name": "Name",
        "MajorRevision": "A",
        "MinorRevision": "1",
        "Type": "Standard",
        "DataGroup": "NoAccess",
        "PlannedVolume": "8.1"
      }
    ],
    "ExcludedMaterialTypes": [
      {
        "Name": "Name"
      }
    ]
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Production_UnitConversionFactors

  The topic used for publishing and consuming all events related to unit conversion factors

  Operation IDUnitConversionFactors

  Accepts the following message:

  UnitConversionFactorsEvent

  Provides conversion factors between different units of measure

  • application/json

  Message IDUnitConversionFactorsEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Material,Area,Flow,Step,Product,ProductGroup,ProductionOrder]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Information:

  Expand all

  object [Site Basic Information]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Unit Conversion Factors:

  Expand all

  object [Unit Conversion Factors]

  Product

  Expand all

  required

  object allOf

  The Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  FromUnit

  required

  string

  The original unit of measure to be converted

  ToUnit

  required

  string

  The target unit of measure after conversion

  ConversionFactor

  required

  number

  The multiplier used to convert from the original unit to the target unit

  Additional properties are allowed.

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Material",
        "Area",
        "Flow",
        "Step",
        "Product",
        "ProductGroup",
        "ProductionOrder"
      ],
      "DataGroups": [
        [
          "2502181710210000004",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "-1",
          "2502181712430124398"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    },
    "FromUnit": "string",
    "ToUnit": "string",
    "ConversionFactor": 0
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Resource_ResourceAlarm

  The topic on which resource alarm events may be produced and consumed.

  Operation IDResourceAlarm

  Accepts the following message:

  Resource AlarmResourceAlarmEvent

  Resource Alarm Set or Clear

  • application/json

  Message IDResourceAlarmEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  Additional properties are allowed.

  Additional properties are allowed.

  And of Resource Alarm:

  Expand all

  object [Resource Alarm]

  Action

  required

  string

  The Alarm action type

  Allowed values:
  • "Set"
  • "Clear"

  Timestamp

  required

  string

  format: date-time

  Timestamp when the Alarm's action was triggered

  Alarm

  Expand all

  required

  object [Alarm Payload]

  Description of an Resource Alarm

  Code

  required

  string

  Alarm Code (UID)

  Examples values:
  • "CausticTemperatureAlarm"

  Type

  string

  Alarm Type

  Severity

  string

  Alarm Severity

  Examples values:
  • "Critical"

  Description

  string

  Alarm Description

  Examples values:
  • "Fresh water tank level low"

  Cause

  string

  Alarm Fault Cause

  Examples values:
  • "Mechanical failure"

  Additional properties are allowed.

  Resource

  Expand all

  required

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  SubResource

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Enterprise

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Site

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Facility

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Area

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  • #Resource
  • #Equipment

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial"
    },
    "Action": "Set",
    "Timestamp": "2019-08-24T14:15:22Z",
    "Alarm": {
      "Code": "CausticTemperatureAlarm",
      "Type": "string",
      "Severity": "Critical",
      "Description": "Fresh water tank level low",
      "Cause": "Mechanical failure"
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name"
    },
    "SubResource": {
      "UID": "2502130212590000467",
      "Name": "Name"
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name"
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name"
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name"
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name"
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Resource_ResourceLayout

  The topic to synchronize resource layout changes. Can be fully consumed for initial load.

  Operation IDResourceLayout

  Accepts the following message:

  Resource LayoutResourceLayoutEvent

  Inform a full Resource Layout

  • application/json

  Message IDResourceLayoutEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId).

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,Area,Resource]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Full information

  Consists of Base Object Full Payload:

  Expand all

  object [Base Object Full Payload]

  Full information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Picture

  string

  The Entity picture

  Examples values:
  • "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Full information

  Consists of Base Object Full Payload:

  Expand all

  object [Base Object Full Payload]

  Full information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Picture

  string

  The Entity picture

  Examples values:
  • "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"

  Additional properties are allowed.

  And of Site Full Information:

  Expand all

  object [Site Full Information]

  DayStartOffset

  required

  number

  format: float

  Examples values:
  • 2

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  Location

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Full information

  Consists of Base Object Full Payload:

  Expand all

  object [Base Object Full Payload]

  Full information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Picture

  string

  The Entity picture

  Examples values:
  • "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Resource Full Layout Payload:

  Expand all

  object [Resource Full Layout Payload]

  Areas

  Expand all

  required

  array<object allOf>

  >= 1

  Items:

  object allOf

  The Full Area information

  Consists of Base Object Full Payload:

  Expand all

  object [Base Object Full Payload]

  Full information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Picture

  string

  The Entity picture

  Examples values:
  • "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"

  Additional properties are allowed.

  And of Area Full Payload:

  Expand all

  object [Area Full Payload]

  DataGroup

  string

  The Area Data Group

  Examples values:
  • "DataGroup"

  Class

  string

  The Area Class

  Allowed values:
  • "Storage"
  • "Process"
  • "Line"

  ManufacturingCalendar

  string

  The Area Manufacturing Calendar

  Examples values:
  • "Manufacturing Calendar One"

  ParentAreas

  Expand all

  array<string>

  The Area Parent Areas

  Examples values:
  • [Area 1,Area 2]

  Items:

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Resources

  Expand all

  required

  array<object allOf>

  >= 1

  Items:

  object allOf

  Consists of Base Object Full Payload:

  Expand all

  object [Base Object Full Payload]

  Full information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity

  Examples values:
  • "2502130212590000005"

  UniversalState

  required

  string

  The Entity Universal State

  Allowed values:
  • "Active"
  • "Terminated"

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Picture

  string

  The Entity picture

  Examples values:
  • "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"

  Additional properties are allowed.

  And of Resource Full Payload:

  Expand all

  object [Resource Full Payload]

  ResourceType

  string

  The Resource Type

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  ModelRevision

  string

  The Resource Model Revision

  Examples values:
  • "V1"
  • "V2"
  • "V3"

  DataGroup

  string

  The Area Data Group

  Examples values:
  • "DataGroup One"

  Manufacturer

  string

  The Resource Manufacturer

  Examples values:
  • "ASMPT"
  • "Fuji"
  • "Panasonic"
  • "Juki"

  SerialNumber

  string

  The Resource Serial Number

  Examples values:
  • "1525XVBGD51563"
  • "CJHGG1626CK"

  Class

  string

  The Resource Class

  Allowed values:
  • "Process"
  • "Transport"
  • "Inspection"
  • "Test"
  • "Material Handling"
  • "Storage"
  • "Feeder"
  • "Module"
  • "Component"
  • "Stage"
  • "Tool"
  • "Line"
  • "LoadPort"

  Criticality

  string

  The Resource Criticality

  Allowed values:
  • "High"
  • "Medium"
  • "Low"

  YearBuilt

  integer

  The year the Resource was Built

  Examples values:
  • 2020
  • 1998

  InstallationDate

  string

  format: date-time

  The Resource Installation Date

  Examples values:
  • "2022"
  • "2019"

  SystemState

  string

  The Resource System State

  Allowed values:
  • "Up"
  • "Down"
  • "Non-Scheduled"

  ControlState

  string

  Examples values:
  • "Off-Line"

  SEMIE10State

  string

  Allowed values:
  • "Engineering"
  • "Nonscheduled"
  • "Productive"
  • "Standby"
  • "Scheduled Down"
  • "Unscheduled Down"

  SEMIE10Date

  string

  format: date-time

  Examples values:
  • "2025-02-11T20:07:57.097"

  SEMIE58State

  string

  Allowed values:
  • "Engineering"
  • "Nonscheduled"
  • "Productive"
  • "Standby"
  • "Scheduled Down"
  • "Unscheduled Down"

  OpenCorrectiveMAOsCount

  integer

  >= 0

  Area

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Recipe

  Expand all

  object allOf

  The Recipe information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  StateNames

  Expand all

  array<string>

  Examples values:
  • [Basic,SEMI-E10]

  Items:

  string

  StateValues

  Expand all

  array<string>

  Examples values:
  • [Up,Standby]

  Items:

  string

  Lanes

  Expand all

  array<string>

  The Resource Lane

  Examples values:
  • [Lane_one,Lane_two]

  Items:

  string

  ParentResources

  Expand all

  array<string>

  Examples values:
  • [Resource A,Resource B]

  Items:

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  required

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Resource

  Expand all

  required

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  Additional properties are allowed.

  • #Resource

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Area",
        "Resource"
      ],
      "DataGroups": [
        [
          "2502181710210000004",
          "2502181710210001231",
          "2502181712430124399",
          "2502181710210006855",
          "2502181710210006857"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "UniversalState": "Active",
      "DisplayOrder": 1,
      "Type": "Standard",
      "Description": "Entity description",
      "Picture": "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "UniversalState": "Active",
      "DisplayOrder": 1,
      "Type": "Standard",
      "Description": "Entity description",
      "Picture": "/api/GenericService/DownloadAttachment/2502130000050000003?open=true",
      "DayStartOffset": 2,
      "Timezone": "GMT Standard Time",
      "Location": "string"
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "UniversalState": "Active",
      "DisplayOrder": 1,
      "Type": "Standard",
      "Description": "Entity description",
      "Picture": "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"
    },
    "Areas": [
      {
        "UID": "2502130212590000467",
        "Name": "Name",
        "CreatedOn": "2025-02-12T20:13:48.047",
        "CreatedBy": "2502130212590000005",
        "ModifiedOn": "2025-02-12T20:13:50.367",
        "ModifiedBy": "2502130212590000005",
        "UniversalState": "Active",
        "DisplayOrder": 1,
        "Type": "Standard",
        "Description": "Entity description",
        "Picture": "/api/GenericService/DownloadAttachment/2502130000050000003?open=true",
        "DataGroup": "DataGroup",
        "Class": "Storage",
        "ManufacturingCalendar": "Manufacturing Calendar One",
        "ParentAreas": [
          "Area 1",
          "Area 2"
        ]
      }
    ],
    "Resources": [
      {
        "UID": "2502130212590000467",
        "Name": "Name",
        "CreatedOn": "2025-02-12T20:13:48.047",
        "CreatedBy": "2502130212590000005",
        "ModifiedOn": "2025-02-12T20:13:50.367",
        "ModifiedBy": "2502130212590000005",
        "UniversalState": "Active",
        "DisplayOrder": 1,
        "Type": "Standard",
        "Description": "Entity description",
        "Picture": "/api/GenericService/DownloadAttachment/2502130000050000003?open=true",
        "ResourceType": "Standard",
        "Position": 0,
        "Model": "SX1",
        "ModelRevision": "V1",
        "DataGroup": "DataGroup One",
        "Manufacturer": "ASMPT",
        "SerialNumber": "1525XVBGD51563",
        "Class": "Process",
        "Criticality": "High",
        "YearBuilt": 2020,
        "InstallationDate": "2022",
        "SystemState": "Up",
        "ControlState": "Off-Line",
        "SEMIE10State": "Engineering",
        "SEMIE10Date": "2025-02-11T20:07:57.097",
        "SEMIE58State": "Engineering",
        "OpenCorrectiveMAOsCount": 0,
        "Area": {
          "UID": "2502130212590000467",
          "Name": "Name"
        },
        "Recipe": {
          "UID": "2502130212590000467",
          "Name": "Name",
          "MajorRevision": "A",
          "MinorRevision": "1"
        },
        "StateNames": [
          "Basic",
          "SEMI-E10"
        ],
        "StateValues": [
          "Up",
          "Standby"
        ],
        "Lanes": [
          "Lane_one",
          "Lane_two"
        ],
        "ParentResources": [
          "Resource A",
          "Resource B"
        ]
      }
    ],
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name"
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name"
    }
  }
  

  This example has been generated automatically.

• RECEIVE CDM_Resource_ResourceStateChange

  The topic on which resource state changes may be produced and consumed

  Operation IDResourceStateChange

  • #LightVariant

  Accepts the following message:

  Resource State ChangeResourceStateChangeEvent

  Inform about a state change of a particular resource

  • application/json

  Message IDResourceStateChangeEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId). Also included in the light event variant.

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event. Also included in the light event variant.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction. Also included in the light event variant.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM. Also included in the light event variant.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction. Also included in the light event variant.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event.

  Allowed values:
  • [Enterprise,Site,Facility,Resource,Area,Employee]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Payload:

  Expand all

  object [Site Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Set Resource State:

  Expand all

  object [Set Resource State]

  Resource

  Expand all

  required

  object allOf

  The Full Resource information

  Consists of Base Object Full Payload:

  Expand all

  object [Base Object Full Payload]

  Full information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  CreatedOn

  required

  string

  format: date-time

  The date on which the entity was created. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:48.047"

  CreatedBy

  required

  string

  The user that created the Entity. Also included in the light event variant.

  Examples values:
  • "2502130212590000005"

  ModifiedOn

  required

  string

  format: date-time

  The date on which the Entity was modified. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.367"

  ModifiedBy

  required

  string

  The user that modified the Entity. Also included in the light event variant.

  Examples values:
  • "2502130212590000005"

  UniversalState

  required

  string

  The Entity Universal State. Also included in the light event variant.

  Allowed values:
  • "Active"
  • "Terminated"

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description. Also included in the light event variant.

  Examples values:
  • "Entity description"

  Picture

  string

  The Entity picture

  Examples values:
  • "/api/GenericService/DownloadAttachment/2502130000050000003?open=true"

  Additional properties are allowed.

  And of Resource Full Payload:

  Expand all

  object [Resource Full Payload]

  ResourceType

  string

  The Resource Type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings.

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model. Also included in the light event variant.

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  ModelRevision

  string

  The Resource Model Revision.

  Examples values:
  • "V1"
  • "V2"
  • "V3"

  Manufacturer

  string

  The Resource Manufacturer. Also included in the light event variant.

  Examples values:
  • "ASMPT"
  • "Fuji"
  • "Panasonic"
  • "Juki"

  SerialNumber

  string

  The Resource Serial Number.

  Examples values:
  • "1525XVBGD51563"
  • "CJHGG1626CK"

  Class

  string

  The Resource Class. Also included in the light event variant.

  Allowed values:
  • "Process"
  • "Transport"
  • "Inspection"
  • "Test"
  • "Material Handling"
  • "Storage"
  • "Feeder"
  • "Module"
  • "Component"
  • "Stage"
  • "Tool"
  • "Line"
  • "LoadPort"

  Criticality

  string

  The Resource Criticality.

  Allowed values:
  • "High"
  • "Medium"
  • "Low"

  YearBuilt

  integer

  The year the Resource was Built.

  Examples values:
  • 2020
  • 1998

  InstallationDate

  string

  format: date-time

  The Resource Installation Date.

  Examples values:
  • "2022"
  • "2019"

  SystemState

  required

  string

  The Resource System State. Also included in the light event variant.

  Allowed values:
  • "Up"
  • "Down"
  • "Non-Scheduled"

  ControlState

  string

  The Resource Control State. Also included in the light event variant.

  Examples values:
  • "Off-Line"

  SEMIE10State

  string

  The Resource SEMI E10 State. Also included in the light event variant.

  Allowed values:
  • "Engineering"
  • "Nonscheduled"
  • "Productive"
  • "Standby"
  • "Scheduled Down"
  • "Unscheduled Down"

  SEMIE10Date

  string

  format: date-time

  Examples values:
  • "2025-02-11T20:07:57.097"

  SEMIE58State

  string

  Allowed values:
  • "Engineering"
  • "Nonscheduled"
  • "Productive"
  • "Standby"
  • "Scheduled Down"
  • "Unscheduled Down"

  OpenCorrectiveMAOsCount

  integer

  >= 0

  The number of open Corrective MAOs for the Resource. Also included in the light event variant.

  Recipe

  Expand all

  object allOf

  The Recipe information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Additional properties are allowed.

  StateNames

  Expand all

  array<string>

  The Resource State Names. Also included in the light event variant.

  Examples values:
  • [Basic,SEMI-E10]

  Items:

  string

  StateValues

  Expand all

  array<string>

  The Resource State Values. Also included in the light event variant.

  Examples values:
  • [Up,Standby]

  Items:

  string

  Lanes

  Expand all

  array<string>

  The Resource Lane. Also included in the light event variant.

  Examples values:
  • [Lane_one,Lane_two]

  Items:

  string

  ParentResources

  Expand all

  array<string>

  The Parent of the current Resource. Also included in the light event variant.

  Examples values:
  • [Resource A,Resource B]

  Items:

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Area

  Expand all

  required

  object allOf

  The Area Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Area Basic Payload:

  Expand all

  object [Area Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Calendar

  Expand all

  object [Calendar Payload]

  Calendar information regarding the time of the event

  Calendar

  required

  string

  The calendar Name

  Examples values:
  • "CalendarName"
  • "Standard"

  CD

  required

  string

  format: date

  The event calendar day

  Examples values:
  • "2025-02-11T00:00:00"
  • "2025-02-11"

  Timezone

  required

  string

  The timezone of the calendar

  Examples values:
  • "GMT Standard Time"
  • "Central Europe Standard Time"
  • "UTC"

  TZToUTCInMin

  integer

  The timezone offset to UTC in minutes

  Examples values:
  • 0
  • 60

  FY

  required

  integer

  The event fiscal year

  Examples values:
  • 2025

  FQ

  required

  integer

  [ 1 .. 4 ]

  The event fiscal quarter

  FM

  required

  integer

  [ 1 .. 12 ]

  The event fiscal month

  FW

  required

  integer

  [ 1 .. 53 ]

  The event fiscal week

  Shift

  Expand all

  object [Shift Basic Payload]

  The event shift Basic information

  ShiftDefinitionName

  required

  string

  The event shift definition

  Examples values:
  • "Shift Definition Name"

  Name

  required

  string

  The event shift name

  Examples values:
  • "Shift 1"

  StartTime

  required

  string

  format: date-time

  The event shift start time

  Examples values:
  • "2025-02-18T18:00:00Z"

  EndTime

  required

  string

  format: date-time

  The event shift end time

  Examples values:
  • "2025-02-19T02:00:00Z"

  Additional properties are allowed.

  Additional properties are allowed.

  Employee

  Expand all

  object allOf

  The Employee information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Employee Payload:

  Expand all

  object [Employee Payload]

  Number

  string

  The employee number

  Examples values:
  • "Employee 001"

  Team

  string

  The employee team

  Examples values:
  • "Team A"

  Additional properties are allowed.

  Additional properties are allowed.

  Previous

  Expand all

  object allOf

  The Previous Resource information (introduced in CDM v11.2.0)

  Consists of Previous Resource Payload:

  Expand all

  object [Previous Resource Payload]

  Resource

  Expand all

  object [Previous Resource Payload]

  The Previous Resource information (introduced in CDM v11.2.0)

  SystemState

  required

  string

  The Resource System State. Also included in the light event variant.

  Allowed values:
  • "Up"
  • "Down"
  • "Non-Scheduled"

  StateNames

  Expand all

  required

  array<string>

  The Resource State Names. Also included in the light event variant.

  Examples values:
  • [Basic,SEMI-E10]

  Items:

  string

  StateValues

  Expand all

  required

  array<string>

  The Resource State Values. Also included in the light event variant.

  Examples values:
  • [Up,Standby]

  Items:

  string

  SEMIE10State

  string

  The Resource SEMI E10 State. Also included in the light event variant.

  Allowed values:
  • "Engineering"
  • "Nonscheduled"
  • "Productive"
  • "Standby"
  • "Scheduled Down"
  • "Unscheduled Down"

  LastModifiedOn

  string

  format: date-time

  The date on which the Entity was last modified. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.367"

  LastModifiedBy

  string

  The last user to modified the Entity. Also included in the light event variant.

  Examples values:
  • "2502130212590000005"

  Additional properties are allowed.

  Area

  Expand all

  object allOf

  The Previous Area information (introduced in CDM v11.2.0)

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Area Payload:

  Expand all

  object [Area Payload]

  Type

  string

  The Entity type. Also included in the light event variant.

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #Resource, LightVariant

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "Resource",
        "Area",
        "Employee"
      ],
      "DataGroups": [
        [
          "2502181710210000004",
          "2502181710210001231",
          "-1",
          "2502181712430124398",
          "-1",
          "2502181710210006855"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "CreatedOn": "2025-02-12T20:13:48.047",
      "CreatedBy": "2502130212590000005",
      "ModifiedOn": "2025-02-12T20:13:50.367",
      "ModifiedBy": "2502130212590000005",
      "UniversalState": "Active",
      "DisplayOrder": 1,
      "Type": "Standard",
      "Description": "Entity description",
      "Picture": "/api/GenericService/DownloadAttachment/2502130000050000003?open=true",
      "ResourceType": "Standard",
      "Position": 0,
      "Model": "SX1",
      "ModelRevision": "V1",
      "Manufacturer": "ASMPT",
      "SerialNumber": "1525XVBGD51563",
      "Class": "Process",
      "Criticality": "High",
      "YearBuilt": 2020,
      "InstallationDate": "2022",
      "SystemState": "Up",
      "ControlState": "Off-Line",
      "SEMIE10State": "Engineering",
      "SEMIE10Date": "2025-02-11T20:07:57.097",
      "SEMIE58State": "Engineering",
      "OpenCorrectiveMAOsCount": 0,
      "Recipe": {
        "UID": "2502130212590000467",
        "Name": "Name",
        "MajorRevision": "A",
        "MinorRevision": "1"
      },
      "StateNames": [
        "Basic",
        "SEMI-E10"
      ],
      "StateValues": [
        "Up",
        "Standby"
      ],
      "Lanes": [
        "Lane_one",
        "Lane_two"
      ],
      "ParentResources": [
        "Resource A",
        "Resource B"
      ]
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Calendar": {
      "Calendar": "CalendarName",
      "CD": "2025-02-11T00:00:00",
      "Timezone": "GMT Standard Time",
      "TZToUTCInMin": 0,
      "FY": 2025,
      "FQ": 1,
      "FM": 1,
      "FW": 1,
      "Shift": {
        "ShiftDefinitionName": "Shift Definition Name",
        "Name": "Shift 1",
        "StartTime": "2025-02-18T18:00:00Z",
        "EndTime": "2025-02-19T02:00:00Z"
      }
    },
    "Employee": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "Number": "Employee 001",
      "Team": "Team A"
    },
    "Previous": {
      "Resource": {
        "SystemState": "Up",
        "StateNames": [
          "Basic",
          "SEMI-E10"
        ],
        "StateValues": [
          "Up",
          "Standby"
        ],
        "SEMIE10State": "Engineering",
        "LastModifiedOn": "2025-02-12T20:13:50.367",
        "LastModifiedBy": "2502130212590000005"
      },
      "Area": {
        "UID": "2502130212590000467",
        "Name": "Name",
        "Type": "Standard"
      }
    }
  }
  

  This example has been generated automatically.

• RECEIVE PostDataCollection

  The topic on which all Data Collection operations may be produced and consumed

  Operation IDPostDataCollection

  • #LightVariant

  Accepts the following message:

  Post Data CollectionPostDataCollectionEvent

  Inform about a operation of a particular data collection.

  • application/json

  Message IDPostDataCollectionEvent

  Payload

  Expand all

  allOf

  Consists of Header Properties:

  Expand all

  object [Header Properties]

  Header

  Expand all

  required

  object [Header]

  CorrelationId

  required

  string

  The correlation identifier between different events of the same transaction (eg. ServiceHistoryId). Also included in the light event variant.

  Examples values:
  • "2204130000020000503"

  Operation

  required

  string

  The operation name that originated the current event. Also included in the light event variant.

  Examples values:
  • "TrackInMaterial"

  DateTime

  required

  string

  format: date-time

  The execution time of the transaction. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.383"

  StartDateTime

  required

  string

  format: date-time

  The start time of the transaction. Also included in the light event variant.

  Examples values:
  • "2025-02-12T20:13:50.330"

  Application

  required

  string

  The application name that performed the transaction. Also included in the light event variant.

  Examples values:
  • "Critical Manufacturing MES"

  CDMVersion

  required

  string

  The version of the CDM. Also included in the light event variant.

  Examples values:
  • "11.3.0"

  Service

  string

  The service name that originated the current transaction. Also included in the light event variant.

  Examples values:
  • "ComplexDispatchAndTrackInMaterial"

  DataGroupsRefs

  Expand all

  object

  A list of all entities in the event

  Allowed values:
  • [Enterprise,Site,Facility,DataCollection,Parameter,Area,Resource,Flow,Step,Material,ParentMaterial,Product]

  Additional properties are allowed.

  DataGroups

  Expand all

  object

  A list of all entity datagroups in the event. The order must match the DataGroupsRefs

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Organization Payload:

  Expand all

  object [Organization Payload]

  Organization information

  Enterprise

  Expand all

  required

  object allOf

  The Enterprise Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Enterprise Basic Payload:

  Expand all

  object [Enterprise Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Site

  Expand all

  required

  object allOf

  The Site Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Site Basic Payload:

  Expand all

  object [Site Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Facility

  Expand all

  required

  object allOf

  The Facility Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Facility Basic Payload:

  Expand all

  object [Facility Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of Production Management DataCollection:

  Expand all

  object [Production Management DataCollection]

  DataCollection

  Expand all

  required

  object [Data Collection Payload]

  Represents the data collection process

  UID

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object

  Examples values:
  • "1"
  • "2"

  Description

  string

  The Entity description. Also included in the light event variant.

  Examples values:
  • "Entity description"

  InstanceName

  required

  string

  The instance name of the data collection. Also included in the light event variant.

  Examples values:
  • "DataCollectionName-0000001"

  ExecutionMode

  string

  The Execution Mode. Also included in the light event variant.

  Examples values:
  • "Immediate"
  • "LongRunning"

  MaterialOperation

  string

  The Material Operation. Also included in the light event variant.

  Examples values:
  • "PerformImmediate"
  • "TrackIn"

  BeginDate

  required

  string

  format: date-time

  The begin date and time of the data collection.

  Examples values:
  • "2025-07-22T00:00:00Z"

  BeginUser

  required

  string

  The user who initiated the data collection.

  Examples values:
  • "User-0001"

  EndDate

  string

  format: date-time

  The end date and time of the data collection.

  Examples values:
  • "2025-07-22T00:00:00Z"

  EndUser

  string

  The user who closed the data collection.

  Examples values:
  • "User-0002"

  Additional properties are allowed.

  Parameter

  Expand all

  required

  object [Parameter Payload]

  Represents the measurement parameters being collected, such as the cookie's thickness, along with instrument and unit information.

  Name

  required

  string

  Name of the parameter being measured. Also included in the light event variant.

  Examples values:
  • "Thickness"

  DataType

  required

  string

  Data type of the measurement. Also included in the light event variant.

  Examples values:
  • "Decimal"

  ReadingNames

  Expand all

  array<string>

  Names of multiple readings, if available. Also included in the light event variant.

  Examples values:
  • [Reading Name]

  Items:

  string

  ReadingNumbers

  Expand all

  required

  array<integer>

  Array of numeric readings. Also included in the light event variant.

  Examples values:
  • [1]

  Items:

  integer

  ReadingValues

  Expand all

  required

  array<string>

  Array of values corresponding to the readings. Also included in the light event variant.

  Examples values:
  • [333]

  Items:

  string

  ReadingSample

  required

  string

  Sample identification for the reading. Also included in the light event variant.

  Examples values:
  • "Sample 1"

  Instrument

  string

  The instrument used to take the measurement, if any. Also included in the light event variant.

  Examples values:
  • "Mixer-01-ResourceInstrument-01"

  Unit

  string

  Unit of the measurement (e.g., mm, cm, etc.). Also included in the light event variant.

  Examples values:
  • "Cookies"
  • "Degree Celsius"

  Description

  string

  Detailed description of the parameter. Also included in the light event variant.

  Examples values:
  • "Thickness"

  Additional properties are allowed.

  Area

  Expand all

  required

  object allOf

  The Area Basic information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Area Basic Payload:

  Expand all

  object [Area Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Resource

  Expand all

  object allOf

  The Basic Resource information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Resource Basic Payload:

  Expand all

  object [Resource Basic Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  ResourceType

  string

  The Resource Type

  Examples values:
  • "Standard"
  • "Chocolate_Oven"

  Position

  integer

  The Resource position relative to its siblings

  Examples values:
  • 0
  • 1

  Model

  string

  The Resource Model

  Examples values:
  • "SX1"
  • "SX2"
  • "TX1"

  Additional properties are allowed.

  Additional properties are allowed.

  Flow

  Expand all

  required

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object. Also included in the light event variant.

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object. Also included in the light event variant.

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  Step

  Expand all

  required

  object allOf

  The Basic Step information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Step Payload:

  Expand all

  object [Step Payload]

  DisplayOrder

  integer

  >= 0

  The display order to sort objects by a property other than the Name.

  Examples values:
  • 1
  • 2

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Additional properties are allowed.

  Additional properties are allowed.

  Material

  Expand all

  required

  object allOf

  The Basic Material information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Material Basic Payload:

  Expand all

  object [Material Basic Payload]

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step. Also included in the light event variant.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  string

  The form of the material. Also included in the light event variant.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process. Also included in the light event variant.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material. Also included in the light event variant.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material. Also included in the light event variant.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material. Also included in the light event variant.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material. Also included in the light event variant.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material. Also included in the light event variant.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material. Also included in the light event variant.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material. Also included in the light event variant.

  Additional properties are allowed.

  Additional properties are allowed.

  ParentMaterial

  Expand all

  object allOf

  The Basic Material information

  Consists of Base Object Basic Payload:

  Expand all

  object [Base Object Basic Payload]

  Basic information of each object

  UID

  required

  string

  Unique identifier across all of the instances of the same type

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object

  Examples values:
  • "Name"

  Additional properties are allowed.

  And of Material Basic Payload:

  Expand all

  object [Material Basic Payload]

  DateEnteredStep

  required

  string

  format: date-time

  The date and time when the material entered the current step.

  Examples values:
  • "2025-02-11T20:28:06.333"

  Form

  string

  The form of the material.

  Examples values:
  • "Batch"

  FlowPath

  required

  string

  The flow path of the material in the process.

  Examples values:
  • "FlowName:A:1/StepName:1"

  LogicalFlowPath

  string

  The logical flow path of the material in the process.

  Examples values:
  • "FlowName/StepName"

  PrimaryQty

  required

  number

  format: float>= 0

  The primary quantity of the material.

  Examples values:
  • 10

  PrimaryUnits

  required

  string

  The primary units of the material.

  Examples values:
  • "UnitA"

  SecondaryQty

  number

  format: float>= 0

  The secondary quantity of the material.

  Examples values:
  • 5

  SecondaryUnits

  string

  The secondary units of the material.

  Examples values:
  • "UnitB"

  SubMaterialsPrimaryQty

  number

  format: float>= 0

  The total primary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialsSecondaryQty

  number

  format: float>= 0

  The total secondary quantity of all sub-materials of the current material.

  Examples values:
  • 2

  SubMaterialCount

  integer

  >= 0

  The number of sub-materials of the current material.

  Additional properties are allowed.

  Additional properties are allowed.

  Product

  Expand all

  required

  object allOf

  The Full Product information

  Consists of Versioned Base Object Payload:

  Expand all

  object [Versioned Base Object Payload]

  Basic information of each versioned object

  UID

  required

  string

  Unique identifier across all of the instances of the same type. Also included in the light event variant.

  Examples values:
  • "2502130212590000467"

  Name

  required

  string

  Name of the object. Also included in the light event variant.

  Examples values:
  • "Name"

  MajorRevision

  string

  Revision of the object. Also included in the light event variant.

  Examples values:
  • "A"
  • "B"

  MinorRevision

  string

  Version of the object. Also included in the light event variant.

  Examples values:
  • "1"
  • "2"

  Additional properties are allowed.

  And of Product Payload:

  Expand all

  object [Product Payload]

  Type

  string

  The Entity type

  Examples values:
  • "Standard"
  • "Process"

  Description

  string

  The Entity description

  Examples values:
  • "Entity description"

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #DataCollection, LightVariant

  Examples

  Payload

  {
    "Header": {
      "CorrelationId": "2204130000020000503",
      "Operation": "TrackInMaterial",
      "DateTime": "2025-02-12T20:13:50.383",
      "StartDateTime": "2025-02-12T20:13:50.330",
      "Application": "Critical Manufacturing MES",
      "CDMVersion": "11.3.0",
      "Service": "ComplexDispatchAndTrackInMaterial",
      "DataGroupsRefs": [
        "Enterprise",
        "Site",
        "Facility",
        "DataCollection",
        "Parameter",
        "Area",
        "Resource",
        "Flow",
        "Step",
        "Material",
        "ParentMaterial",
        "Product"
      ],
      "DataGroups": [
        [
          "2502181710210000004",
          "2502181710210001231",
          "-1",
          "-1",
          "2502181712430124399",
          "2502181710210006855",
          "-1",
          "-1",
          "-1",
          "-1",
          "-1",
          "2502181712430124398"
        ]
      ]
    },
    "Enterprise": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Site": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "Facility": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1
    },
    "DataCollection": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Description": "Entity description",
      "InstanceName": "DataCollectionName-0000001",
      "ExecutionMode": "Immediate",
      "MaterialOperation": "PerformImmediate",
      "BeginDate": "2025-07-22T00:00:00Z",
      "BeginUser": "User-0001",
      "EndDate": "2025-07-22T00:00:00Z",
      "EndUser": "User-0002"
    },
    "Parameter": {
      "Name": "Thickness",
      "DataType": "Decimal",
      "ReadingNames": [
        "Reading Name"
      ],
      "ReadingNumbers": [
        1
      ],
      "ReadingValues": [
        "333"
      ],
      "ReadingSample": "Sample 1",
      "Instrument": "Mixer-01-ResourceInstrument-01",
      "Unit": "Cookies",
      "Description": "Thickness"
    },
    "Area": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Resource": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "ResourceType": "Standard",
      "Position": 0,
      "Model": "SX1"
    },
    "Flow": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1"
    },
    "Step": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DisplayOrder": 1,
      "Type": "Standard"
    },
    "Material": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0
    },
    "ParentMaterial": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "DateEnteredStep": "2025-02-11T20:28:06.333",
      "Form": "Batch",
      "FlowPath": "FlowName:A:1/StepName:1",
      "LogicalFlowPath": "FlowName/StepName",
      "PrimaryQty": 10,
      "PrimaryUnits": "UnitA",
      "SecondaryQty": 5,
      "SecondaryUnits": "UnitB",
      "SubMaterialsPrimaryQty": 2,
      "SubMaterialsSecondaryQty": 2,
      "SubMaterialCount": 0
    },
    "Product": {
      "UID": "2502130212590000467",
      "Name": "Name",
      "MajorRevision": "A",
      "MinorRevision": "1",
      "Type": "Standard",
      "Description": "Entity description"
    }
  }
  

  This example has been generated automatically.

• RECEIVE PostMeasurement

  The topic on which all measurement operations may be produced and consumed

  Operation IDPostMeasurement

  Accepts the following message:

  Post MeasurementPostMeasurementEvent

  Inform a Measurement event

  • application/json

  Message IDPostMeasurementEvent

  Payload

  Expand all

  object

  Parameters

  Expand all

  required

  array<string>

  >= 0

  Examples values:
  • [Parameter 1]

  Items:

  string

  Values

  Expand all

  required

  array<string>

  >= 0

  Examples values:
  • [Value 1]

  Items:

  string

  Measurement

  Expand all

  object

  Name

  required

  string

  The Measurement Name

  Examples values:
  • "Measurement01"

  Additional properties are allowed.

  Enterprise

  Expand all

  object

  Name

  string

  The Enterprise Name

  Examples values:
  • "Enterprise01"

  Additional properties are allowed.

  Site

  Expand all

  object

  Name

  string

  The Site Name

  Examples values:
  • "Site01"

  Additional properties are allowed.

  Facility

  Expand all

  object

  Name

  string

  The Facility Name

  Examples values:
  • "Facility01"

  Additional properties are allowed.

  Area

  Expand all

  object

  Name

  string

  The Area Name

  Examples values:
  • "Area01"

  Additional properties are allowed.

  Resource

  Expand all

  object

  Name

  string

  The Resource Name

  Examples values:
  • "Resource01"

  Additional properties are allowed.

  Material

  Expand all

  object

  Name

  string

  The Material Name

  Examples values:
  • "Material01"

  Additional properties are allowed.

  Recipe

  Expand all

  object

  Name

  string

  The Recipe Name

  Examples values:
  • "Recipe01"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "Parameters": [
      "Parameter 1"
    ],
    "Values": [
      "Value 1"
    ],
    "Measurement": {
      "Name": "Measurement01"
    },
    "Enterprise": {
      "Name": "Enterprise01"
    },
    "Site": {
      "Name": "Site01"
    },
    "Facility": {
      "Name": "Facility01"
    },
    "Area": {
      "Name": "Area01"
    },
    "Resource": {
      "Name": "Resource01"
    },
    "Material": {
      "Name": "Material01"
    },
    "Recipe": {
      "Name": "Recipe01"
    }
  }
  

  This example has been generated automatically.

• RECEIVE PostTelemetry

  The topic on which all Resource Telemetry operations may be produced and consumed

  Operation IDPostTelemetry

  Accepts the following message:

  Post TelemetryPostTelemetryEvent

  Inform a telemetry event

  • application/json

  Message IDPostTelemetryEvent

  Payload

  Expand all

  object

  Parameters

  Expand all

  array<object>

  >= 0

  object

  Name

  string

  Parameter Name

  Examples values:
  • "Pressure"

  Class

  string

  Class

  Allowed values:
  • "Sensor"
  • "State"
  • "Property"

  Timestamps

  Expand all

  array<number>

  >= 0

  Timestamps of sensor values

  Items:

  number

  format: long

  Examples values:
  • 1698660437706
  • 1681466820000

  NumericValues

  Expand all

  array<number>

  >= 0

  Numeric values of sensor

  Items:

  number

  format: float

  Examples values:
  • 1.04
  • 29.6
  • 29.4
  • 30

  StringValues

  Expand all

  array<string>

  >= 0

  String values of sensor

  Items:

  string

  Examples values:
  • "On"
  • "Off"
  • "Standby"

  UnitOfMeasure

  string

  Unit of Measure

  Examples values:
  • "Pascal"

  Additional properties are allowed.

  Tags

  Expand all

  array<object>

  >= 0

  object

  Key

  string

  Tag Key

  Examples values:
  • "Tag1"
  • "Tag2"

  Value

  string

  Tag Value

  Examples values:
  • "Value1"
  • "Value2"

  Additional properties are allowed.

  Enterprise

  Expand all

  object

  Name

  string

  The Enterprise Name

  Examples values:
  • "Enterprise01"

  Additional properties are allowed.

  Site

  Expand all

  object

  Name

  string

  The Site Name

  Examples values:
  • "Site01"

  Additional properties are allowed.

  Facility

  Expand all

  object

  Name

  string

  The Facility Name

  Examples values:
  • "Facility01"

  Additional properties are allowed.

  Area

  Expand all

  object

  Name

  string

  The Area Name

  Examples values:
  • "Area01"

  Additional properties are allowed.

  Resource

  Expand all

  object

  Name

  string

  The Resource Name

  Examples values:
  • "Resource01"

  Additional properties are allowed.

  Flow

  Expand all

  object

  Name

  string

  The Flow Name

  Examples values:
  • "Flow01"

  Additional properties are allowed.

  Step

  Expand all

  object

  Name

  string

  The Step Name

  Examples values:
  • "Step01"

  Additional properties are allowed.

  Material

  Expand all

  object

  Name

  string

  The Material Name

  Examples values:
  • "Material01"

  Additional properties are allowed.

  Product

  Expand all

  object

  Name

  string

  The Product Name

  Examples values:
  • "Product01"

  Additional properties are allowed.

  Additional properties are allowed.

  • #Equipment

  Examples

  Payload

  {
    "Parameters": [
      {
        "Name": "Pressure",
        "Class": "Sensor",
        "Timestamps": [
          1698660437706
        ],
        "NumericValues": [
          1.04
        ],
        "StringValues": [
          "On"
        ],
        "UnitOfMeasure": "Pascal"
      }
    ],
    "Tags": [
      {
        "Key": "Tag1",
        "Value": "Value1"
      }
    ],
    "Enterprise": {
      "Name": "Enterprise01"
    },
    "Site": {
      "Name": "Site01"
    },
    "Facility": {
      "Name": "Facility01"
    },
    "Area": {
      "Name": "Area01"
    },
    "Resource": {
      "Name": "Resource01"
    },
    "Flow": {
      "Name": "Flow01"
    },
    "Step": {
      "Name": "Step01"
    },
    "Material": {
      "Name": "Material01"
    },
    "Product": {
      "Name": "Product01"
    }
  }
  

  This example has been generated automatically.