1. Overview
Microservice containing the business logic for validating and processing different import requests like WorkOrder, ProcessOrder, Material, MaterialLot, OSP and MBOM.
Descriptions of these functions can be found in the section headers for each collection of relevant resources.
2. Resources
2.1. Import-service-controller
Import Service Controller
2.1.1. Import Assignments Lots
POST /v1/importAssignmentsLots
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import Assignment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Validated |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Validation Failed |
No Content |
500 |
Internal server error |
No Content |
2.1.2. Import data entry plan
POST /v1/importDataEntryPlan
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import data entry plan |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
No Content |
500 |
Internal server error |
No Content |
2.1.3. Get the statuses of the submitted jobs
GET /v1/importJobs/{jobIdsList}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
jobIdsList |
List of comma separated Job Ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< ResponseInfo > array |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.4. Import MBOM
POST /v1/importMBOM
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import BOM |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Validated |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Validation Failed |
No Content |
500 |
Internal server error |
No Content |
2.1.5. Import Material
POST /v1/importMaterialJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import Material with media type of XML/JSON, Job Id and the import message specified. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.6. Import MaterialLots
POST /v1/importMaterialLotJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import Material Lots with media type of XML/JSON, Job Id and the import message itself specified. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.7. Import Osp
POST /v1/importOspJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import OSP with media type of XML/JSON, Job Id and the import message itself specified. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.8. Import ProcessOrder
POST /v1/importProcessOrderJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import ProcessOrder with media type of XML/JSON, Job Id and the import message itself specified. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.9. Import route
POST /v1/importRoute
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import route with media type of JSON, Job Id and the import message itself specified. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.10. Import Tool
POST /v1/importTool
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
import Tool |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
No Content |
500 |
Internal server error |
No Content |
2.1.11. Import WorkOrder
POST /v1/importWorkOrderJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Import WorkOrder with media type of XML/JSON, Job Id and the import message specified. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.12. Get the number of submitted but yet to be processed requests or jobs. It is recommended to check if the size is less than 100 before submitting any new request or job. If the size is 100 or more, wait for some time for it come down to below 100.
GET /v1/queueSize
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
3. Definitions
3.1. BillOfMaterialInfo
Bill of Materials of a work order.
| Name | Description | Schema |
|---|---|---|
behaviors |
behaviors of the material |
< string > array |
bomItemId |
Bom Item Id of the material |
integer (int32) |
bomItemName |
string |
|
defaultStorageUnit |
Name of the defaultStorageUnit |
string |
defaultStorageUnitId |
defaultStorageUnitId of the material |
integer (int32) |
displayOrder |
display order of the Bom Item |
integer (int32) |
lowerTolerance |
lowerTolerance of the material |
number (double) |
lowerTolerancePrecision |
lowerTolerancePrecision of the material |
integer (int32) |
materialId |
Id of the material |
integer (int64) |
materialName |
Name of the material |
string |
propertyValues |
< MaterialProperties > array |
|
quantity |
Quantity of the material |
number (double) |
quantityPrecision |
quantityPrecision of the material |
integer (int32) |
requiresConsumptionTracking |
Determines if Consumption is required |
boolean |
scrapFactor |
scrapFactor of the material |
number (double) |
substitution |
< Substitutions > array |
|
unitOfMeasureId |
Id of the unitOfMeasure |
integer (int64) |
unitOfMeasureName |
unit Of Measure |
string |
upperTolerance |
upperTolerance of the material |
number (double) |
upperTolerancePrecision |
upperTolerancePrecision of the material |
integer (int32) |
3.2. DocumentInfo
Documents of a route.
| Name | Description | Schema |
|---|---|---|
displayName |
Name of the document |
string |
link |
Link of the document |
string |
3.3. MaterialInfo
Material Information from ERP to import a material.
| Name | Description | Schema |
|---|---|---|
externalRevision |
Product external revision info |
integer (int32) |
isSerialized |
The product Id is serialized or not |
boolean |
productCode |
ProductCode of the material |
string |
productDescription |
ProductDescription of the material |
string |
productFamily |
ProductFamily of the material |
string |
propertyValues |
Properties of the material |
< MaterialProperties > array |
3.4. MaterialLotImportDocumentInfo
MaterialLot Information from ERP to import a MaterialLot.
| Name | Description | Schema |
|---|---|---|
materialLot |
List of material lots |
< MaterialLotInfo > array |
schemaVersion |
Version of the MaterialLot document |
integer (int32) |
3.5. MaterialLotInfo
Information from ERP to import a MaterialLot.
| Name | Description | Schema |
|---|---|---|
description |
Description of the materialLot |
string |
isSerialized |
The product Id is serialized or not |
boolean |
lotIdentifier |
Name of the materialLot |
string |
materialLotId |
Id of materialLot |
integer (int64) |
materialSubLots |
List of MaterialSubLots |
< MaterialSubLots > array |
processOrderId |
processOrderId |
integer (int64) |
productId |
productId |
integer (int64) |
productName |
Name of the Product |
string |
productionLine |
Name of the ProductionLine |
string |
productionUnit |
Name of the productionUnit |
string |
propertyValues |
properties associated to a materialLot. |
< MaterialProperties > array |
quantity |
Quantity of the Product |
number (double) |
segmentId |
segmentId |
integer (int64) |
status |
Status of the materialLot |
string |
statusId |
Id of the Status |
integer (int64) |
unitId |
Id of the Unit |
integer (int64) |
unitOfMeasure |
UnitOfMeasure associated to Unit |
string |
unitOfMeasureId |
unitOfMeasureId |
integer (int64) |
workOrderId |
workOrderId |
integer (int64) |
3.6. MaterialMasterInfo
Material to import.
| Name | Description | Schema |
|---|---|---|
material |
Material details. |
|
productionLines |
Units to which material will be associated. |
< string > array |
schemaVersion |
Schema version of the material master import document |
integer (int32) |
storageUnit |
Storage Unit |
string |
storageZone |
Storage Zone |
string |
unitOfMeasureId |
integer (int64) |
3.7. MaterialProperties
Properties of a material.
| Name | Description | Schema |
|---|---|---|
propertyDataType |
Datatype of property |
string |
propertyDefinitionId |
Id of property |
string |
propertyName |
Name of the property |
string |
propertyValue |
Value of the property |
string |
required |
boolean |
3.9. OperationsGroupInfo
OperationsGroupInfo data tranfer object
| Name | Description | Schema |
|---|---|---|
operations |
List Of Operations. |
< OperationsInfo > array |
route |
Route Operation details. |
3.10. OperationsInfo
Operation data tranfer object
| Name | Description | Schema |
|---|---|---|
behaviors |
Behaviors associated to operation |
< string > array |
billOfMaterials |
Bill of materials associated to operation |
< BillOfMaterialInfo > array |
description |
Description of the operation |
string |
displayOrder |
displayOrder of the operation |
integer (int32) |
documents |
Documents associated to operation |
< DocumentInfo > array |
id |
integer (int64) |
|
laborTypeIds |
< integer (int64) > array |
|
name |
Name of the operation |
string |
plannedUnitIds |
units associated to a operation |
< integer (int64) > array |
plannedUnitNames |
Name of the units associated to a operation |
< string > array |
propertyValues |
properties associated to operation |
< MaterialProperties > array |
sequenceNumber |
Sequence number of the operation |
integer (int32) |
skipIfSuccessorStarted |
skipIfSuccessorStart to operation |
boolean |
suggestedLaborTypes |
laborTypes associated to operation |
< string > array |
3.11. ProcessOrderImportDocumentInfo
Process Order Information from ERP to import a Process order.
| Name | Description | Schema |
|---|---|---|
blockNumber |
blockNumber of the processorder |
string |
bomFormulation |
bomFormulation of the processorder |
string |
bomFormulationId |
bomFormulationId of the processorder |
integer (int64) |
extendedInfo |
extendedInfo of the processorder |
string |
orderTypeId |
orderTypeId of the processorder |
integer (int64) |
path |
path of the processorder |
string |
pathId |
pathId of the processorder |
integer (int64) |
plannedEndDate |
plannedEndDate of the workorder |
string (date-time) |
plannedLineId |
plannedLineId of the workorder |
integer (int32) |
plannedLineName |
plannedLineName of the workorder |
string |
plannedQuantity |
plannedQuantity of the processorder |
number (double) |
plannedStartDate |
plannedStartDate of the workorder |
string (date-time) |
priority |
priority of the workorder |
integer (int32) |
processOrderName |
Name of the processorder |
string |
producedMaterialId |
producedMaterialId of the workorder |
integer (int64) |
producedMaterialName |
producedMaterialName of the workorder |
string |
productionRate |
productionRate of the processorder |
number (double) |
propertyValues |
Properties of the processorder |
< MaterialProperties > array |
schemaVersion |
Version of the Workorder document |
integer (int32) |
status |
status of the processorder |
string |
statusId |
statusId of the processorder |
integer (int64) |
userGeneral1 |
userGeneral1 of the processorder |
string |
userGeneral2 |
userGeneral2 of the processorder |
string |
userGeneral3 |
userGeneral3 of the processorder |
string |
3.12. RequestInfo
| Name | Description | Schema |
|---|---|---|
jobId |
Job Id, this should be unique integer value for each request. |
integer (int64) |
mediaType |
Media type, either application/xml or application/json |
string |
message |
Message describing the WorkOrder/Material/MaterialLot/OSP/ProcessOrder being imported. Please visit the 'ERP Integration Guide' for the details of the message structure for each type of import and media type. |
string |
3.13. ResponseInfo
| Name | Schema |
|---|---|
jobId |
integer (int64) |
keyData |
string |
orgCode |
string |
responseCode |
integer (int32) |
responseMessage |
< string > array |
3.14. RouteOperationInfo
RouteOperationInfo data tranfer object
| Name | Description | Schema |
|---|---|---|
behaviors |
Behaviors associated to Route operation |
< string > array |
billOfMaterials |
List of Bill of materials associated to Route operation |
< BillOfMaterialInfo > array |
documents |
List of documents associated to Route operation |
< DocumentInfo > array |
propertyValues |
properties associated to Route operation |
< MaterialProperties > array |
3.15. Substitutions
substitutions of the material
| Name | Description | Schema |
|---|---|---|
conversionFactor |
conversionFactor of the substitute |
number (double) |
materialName |
Material Name of the substitute |
string |
unitOfMeasureName |
unitOfMeasure Name of the substitute |
string |
3.16. WorkOrderImportDocumentInfo
WorkOrderImportDocumentInfo data tranfer object
| Name | Description | Schema |
|---|---|---|
operationsGroup |
OperationsGroup Info |
|
plannedEndDate |
plannedEndDate of the workorder |
string (date-time) |
plannedLineId |
plannedLineId of the workorder |
integer (int32) |
plannedLineName |
plannedLineName of the workorder |
string |
plannedStartDate |
plannedStartDate of the workorder |
string (date-time) |
priority |
priority of the workorder |
integer (int32) |
producedMaterialId |
producedMaterialId of the workorder |
integer (int64) |
producedMaterialName |
producedMaterialName of the workorder |
string |
routeDefinitionId |
Route Definition Id |
integer (int64) |
routeDefinitionMinorRevision |
Route Definition Minor Revision |
integer (int32) |
routeDefinitionName |
Route Definition Name |
string |
routeDefinitionRevision |
Route Definition Revision |
integer (int32) |
schemaVersion |
Version of the Workorder document |
integer (int32) |
workOrderName |
Name of the Workorder |
string |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : http://uaa:8080/uaa/oauth/authorize
Token URL : http://uaa:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : http://uaa:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : http://uaa:8080/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : http://uaa:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |