Payload details

Case Use cases

Payload for create product use case.

ProductsV2

{
"ProductDimensionGroupName": "Rev",
"ProductSubType": "ProductMaster",
"ProductType": "Item",
"VariantConfigurationTechnology": "PredefinedVariants",
"ProductName": "<Description>",
"ProductNumber": "<Product number>"
}

ReleasedProductsV2

{
  "ItemModelGroupId": "MA",
  "ProductDimensionGroupName": "Rev",
  "ProductGroupId": "1000",
  "ProductionType": "BOM",
  "StorageDimensionGroupName": "INV",
  "TrackingDimensionGroupName": "None",
  "dataAreaId": "<Company ID in D365 FO>",
  "ItemNumber": "<Product number>",
  "ProductNumber": "<Product number>",
  "NetProductWeight": <Net weight>,
  "PurchaseUnitSymbol": "<Unit of measure>",
  "InventoryUnitSymbol": "<Unit of measure>",
  "SalesUnitSymbol": "<Unit of measure>",
  "DefaultOrderType": "Production",
  "ProductLifecycleStateId": "In work"
}

ProductMasterStyles

{
  "ProductMasterNumber": "<Product number>",
  "ProductStyleId": "<Revision>"
}

ReleasedProductVariantsV2

{
  "ProductMasterNumber": "<Product number>",
  "ProductStyleId": "<Revision>",
  "ItemNumber": "<Product number>",
  "dataAreaId": "<Company ID in D365 FO>"
}

BillOfMaterialsHeadersV2

{
  "ProductStyleId": "<Revision>",
  "dataAreaId": "<Company ID in D365 FO>",
  "ProductionSiteId": "<Plant ID in D365 FO>",
  "ManufacturedItemNumber": "<Product number>",
  "BOMName": "<Description>",
  "BOMId": "<BOM ID>"
}

Payload to update product attributes use case.

UpdateProductsV2

{
  "ProductName": "<Description>",
  "ProductDescription": "<Description>"
}

UpdateReleasedProductsV2

{
  "NetProductWeight": "<Net weight>",
  "PurchaseUnitSymbol": "<Unit of measure>",
  "InventoryUnitSymbol": "<Unit of measure>",
  "SalesUnitSymbol": "<Unit of measure>"
}

Payload for send BOM use case.

SendBOM

<Document>
    <BOMBILLOFMATERIALSLINEV3ENTITY>
        <ConsumptionSiteId> Organization Plant ID in D365 FO </ConsumptionSiteId>
        <ConsumptionWarehouseId> Warehouse ID in D365 FO </ConsumptionWarehouseId>
        <dataAreaId> Company ID in D365 FO </dataAreaId>
        <BOMID> BOMID </BOMID>
        <POSITIONNUMBER></POSITIONNUMBER>
        <QUANTITY> Material quantity </QUANTITY>
        <ITEMNUMBER> Product Number </ITEMNUMBER>
        <PRODUCTSTYLEID> Product revision </PRODUCTSTYLEID>
    </BOMBILLOFMATERIALSLINEV3ENTITY>
</Document>

Payload for release documents use case.

ReleasedDocuments

{
  "dataAreaId": "<Company ID in D365 FO>",
  "ItemNumber": "<Product number>",
  "DocumentAttachmentTypeCode": "<Document type mentioned in D365 FO to save the file to the unique location>",
  "AttachmentDescription": "<Description>",
  "ProductImageUsage": "External",
  "AccessRestriction": "Internal",
  "FileType": "<Type of file>",
  "OriginalFileName": "<Name of file>",
  "AttachingUserId": "<Attachment owner>",
  "IsProductImage": "No",
  "Notes": "<Description>",
  "IsDefaultProductImage": "No",
  "DocumentAttachmentTypeLegalEntityId": "<Company ID in D365 FO>",
  "Attachment": "<Base64 encoded data>"
}

if DocumentAttachmentTypeCode is File then in the payload Attachment contains the Base64 encoded file content, if DocumentAttachmentTypeCode is URL then in the payload Notes contains the URI to launch Document Management App in 3DDashboard.

Payload for revise product use case.

ProductMasterStyles

{
  "ProductMasterNumber": "<Product number>",
  "ProductStyleId": "<Revision>"
}

ReleasedProductVariantsV2

{
  "ProductMasterNumber": "<Product number>",
  "ProductStyleId": "<Revision>",
  "ItemNumber": "<Product number>",
  "dataAreaId": "<Company ID in D365 FO>"
}

BillOfMaterialsHeadersV2

{
  "ProductStyleId": "<Revision>",
  "dataAreaId": "<Company ID in D365 FO>",
  "ProductionSiteId": "<Plant ID in D365 FO>",
  "ManufacturedItemNumber": "<Product number>",
  "BOMName": "<Description>",
  "BOMId": "<BOM ID>"
}

Payload for create change use case.

CreateChange

{
  "CategoryId": "CO",
  "CategoryType": "General",
  "CaseStatus": "Planned",
  "dataAreaId": "<Company ID in D365 FO>",
  "PartyNumber": "000002630",
  "CaseId": "<Case ID>",
  "Description": "<Description>",
  "Notes": "<Description>"
}

Payload for create changeAssociation use case.

ChangeAssociation

{
  "EntityType": "BOM",
  "AssociationCompany": "<Associated Company ID in D365 FO>",
  "dataAreaId": "<Company ID in D365 FO>",
  "AssociationId": "<BOM ID>",
  "CaseId": "<Case ID>"
}

Payload to create MBOM use case.

MBOMProductsV2

{
"ProductDimensionGroupName": "Rev",
"ProductSubType": "ProductMaster",
"ProductType": "Item",
"VariantConfigurationTechnology": "PredefinedVariants",
"ProductName": "<Description>",
"ProductNumber": "<Product number>"
}

MBOMReleasedProductsV2

{
  "ItemModelGroupId": "MA",
  "ProductDimensionGroupName": "Rev",
  "ProductGroupId": "1000",
  "ProductionType": "BOM",
  "StorageDimensionGroupName": "INV",
  "TrackingDimensionGroupName": "None",
  "dataAreaId": "<Company ID in D365 FO>",
  "ItemNumber": "<Product number>",
  "ProductNumber": "<Product number>",
  "NetProductWeight": <Net weight>,
  "PurchaseUnitSymbol": "<Unit of measure>",
  "InventoryUnitSymbol": "<Unit of measure>",
  "SalesUnitSymbol": "<Unit of measure>",
  "DefaultOrderType": "Production",
  "ProductLifecycleStateId": "In work",
  "UnitCost": "<Estimated Cost>",
  "PurchasePrice": "<Estimated Cost>",
  "SalesPrice": "<Estimated Cost>"
}

MBOMProductMasterStyles

{
  "ProductMasterNumber": "<Product number>",
  "ProductStyleId": "<Revision>"
}

MBOMReleasedProductVariantsV2

{
  "ProductMasterNumber": "<Product number>",
  "ProductStyleId": "<Revision>",
  "ItemNumber": "<Product number>",
  "dataAreaId": "<Company ID in D365 FO>"
}

MBOMBillOfMaterialsHeadersV2

{
  "ProductStyleId": "<Revision>",
  "dataAreaId": "<Company ID in D365 FO>",
  "ProductionSiteId": "<Plant ID in D365 FO>",
  "ManufacturedItemNumber": "<Product number>",
  "BOMName": "<Description>",
  "BOMId": "<BOM ID>",
  "IsApproved": "Yes",
  "ApproverPersonnelNumber": "<Approver Personnel Number>"
}

Payload to update MBOM attributes use case.

UpdateMBOMProductsV2

{
  "ProductName": "<Description>",
  "ProductDescription": "<Description>"
}

UpdateMBOMReleasedProductsV2

{
  "NetProductWeight": "<Net weight>",
  "PurchaseUnitSymbol": "<Unit of measure>",
  "InventoryUnitSymbol": "<Unit of measure>",
  "SalesUnitSymbol": "<Unit of measure>",
  "UnitCost": "<Estimated Cost>",
  "PurchasePrice": "<Estimated Cost>",
  "SalesPrice": "<Estimated Cost>"
}

Payload for send MBOM use case.

SendMBOM

<Document>
    <BOMBILLOFMATERIALSLINEV3ENTITY>
        <ConsumptionSiteId> Organization Plant ID in D365 FO </ConsumptionSiteId>
        <ConsumptionWarehouseId> Warehouse ID in D365 FO </ConsumptionWarehouseId>
        <dataAreaId> Company ID in D365 FO </dataAreaId>
        <BOMID> BOMID </BOMID>
        <POSITIONNUMBER></POSITIONNUMBER>
        <QUANTITY> Material quantity </QUANTITY>
        <ITEMNUMBER> Product Number </ITEMNUMBER>
        <PRODUCTSTYLEID> Product revision </PRODUCTSTYLEID>
    </BOMBILLOFMATERIALSLINEV3ENTITY>
</Document>

ECM Use cases

Payload to create change action use case.

CreateChange

{
  "dataAreaId": "<Company ID in D365 FO>",
  "EngineeringChangeCategoryName": "<Engineering change category name in D365 FO>",
  "ProjectId": "",
  "OrderResponsiblePersonnelNumber": "",
  "EngineeringChangePriorityName": "<Engineering change priority name in D365 FO>",
  "EngineeringChangeSeverityName": "",
  "EngineerPersonnelNumber": "",
  "ProjectLegalEntityId": "<Project legal entity ID in D365 FO>",
  "OrderNumber": "<Change action number>",
  "OrderTitle": "<Description>",
  "Notes": ""
}

Payload for product, product and CA mapping, BOM head, BOM line.

ReleasedEngineeringProductCreation

{
  "dataAreaId": "<Company ID in D365 FO>",
  "ProductColorId": "",
  "ProductSizeId": "",
  "ProductConfigurationId": "",
  "ProductOwnerId": "",
  "EngineeringProductCategoryName": "<Engineering product category name in D365 FO>",
  "ItemNumber": "<Product number>",
  "Description": "",
  "SearchName": "",
  "ProductName": "",
  "ProductStyleId": "<Product revision>",
  "ProductVersionId": "<Product revision>"
}

EngineeringChangeOrderProductsV3

{
  "dataAreaId": "<Company ID in D365 FO>",
  "LineNumber": <TBD>,
  "EngineeringChangeOrderNumber": "<Change action number>",
  "CurrentItemNumber": "<Product number>",
  "EngineeringChangeImpactType": "NewVersion",
  "EngineeringProductCategoryDetailsName": "<Engineering product category detqails name in D365 FO>",
  "ProductDescription": "",
  "NetProductWeight": <Product weight>
}

CreateBOMHeader

{
  "dataAreaId": "<Company ID in D365 FO>",
  "EngineeringChangeOrderProductLineNumber": <TBD>,
  "ProductionSiteId": "<Production site ID in D365 FO>",
  "ApproverPersonnelNumber": "<Approver Personnel Number>",
  "IsApproved": true,
  "EngineeringChangeOrderNumber": "<Change action number>",
  "BOMId": "<BOM ID>",
  "BOMName": ""
}

CreateBOMLines

{
  "dataAreaId": "<Company ID in D365 FO>",
  "EngineeringChangeOrderNumber": "<Change action number>",
  "EngineeringChangeOrderProductLineNumber": <TBD>,
  "EngineeringChangeOrderProductBillOfMaterialsHeaderCreationSequenceNumber": <TBD>,
  "ItemNumber": "<Product number>",
  "ProductUnitSymbol": "<Unit of measure>",
  "ProductStyleId": "<Product revision>",
  "Quantity": <Product quantity>
}