2. Resources
2.1. Import-service-controller
Import Service Controller
2.1.1. Get JOB Status
GET /v1/importJobs/{jobIdsList}
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.2. Import Material
POST /v1/importMaterialJobs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
202 |
Accepted |
object |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.3. Import Multiple MaterialLot
POST /v1/importMaterialLotJobs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
202 |
Accepted |
object |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.4. Import Osp
POST /v1/importOspJobs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
202 |
Accepted |
object |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.5. Import ProcessOrder
POST /v1/importProcessOrderJobs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
202 |
Accepted |
object |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.6. Import WorkOrder
POST /v1/importWorkOrderJobs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
202 |
Accepted |
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) |
displayOrder |
display order of the Bom Item |
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) |
requiresConsumptionTracking |
Determines if Consumption is required |
boolean |
unitOfMeasureId |
Id of the unitOfMeasure |
integer (int64) |
unitOfMeasureName |
unit Of Measure |
string |
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 |
|---|---|---|
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) |
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) |
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 |
documents |
Documents associated to operation |
< DocumentInfo > 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) |
3.11. ProcessOrderImportDocumentInfo
Process Order Information from ERP to import a Process order.
| Name | Description | Schema |
|---|---|---|
bomFormulation |
bomFormulation of the processorder |
string |
bomFormulationId |
bomFormulationId of the processorder |
integer (int64) |
orderTypeId |
orderTypeId of the processorder |
integer (int64) |
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 |
schemaVersion |
Version of the Workorder document |
integer (int32) |
statusId |
statusId of the processorder |
integer (int64) |
3.12. RequestInfo
| Name | Description | Schema |
|---|---|---|
jobId |
Job Id |
integer (int64) |
mediaType |
Media Type either application/XML or application/Json |
string |
message |
Message of Workorder/Material/Material Lot/OSP/Process Order |
string |
3.13. ResponseInfo
| Name | Schema |
|---|---|
jobId |
integer (int64) |
keyData |
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. 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) |
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 : https://10.181.213.180/uaa/oauth/authorize
Token URL : https://10.181.213.180/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://10.181.213.180/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://10.181.213.180/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://10.181.213.180/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |