1. Overview
Microservice containing the business logic for validating and processing different import requests like WorkOrder, ProcessOrder, Material, MaterialLot and OSP.
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. Get the statuses of the submitted jobs
GET /v1/importJobs/{jobIdsList}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.2. Import Material
POST /v1/importMaterialJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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 |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.3. Import MaterialLots
POST /v1/importMaterialLotJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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 |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.4. Import OSP
POST /v1/importOspJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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 |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.5. Import ProcessOrder
POST /v1/importProcessOrderJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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 |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.6. Import WorkOrder
POST /v1/importWorkOrderJobs
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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 |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.1.7. 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
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. RequestInfo
| Name | Description | Schema |
|---|---|---|
jobId |
Job Id, this should be unique interger 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 Reference section in the "ERP Integration Guide" for the details of the message structure for each type of import and media type. |
string |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://uaaservicehostingservername.domain.com/uaa/oauth/authorize
Token URL : https://uaaservicehostingservername.domain.com/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://uaaservicehostingservername.domain.com/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://uaaservicehostingservername.domain.com/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://uaaservicehostingservername.domain.com/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |