1. Overview

Microservice containing the business logic for managing erp-scheduler-service.

Descriptions of these functions can be found in the section headers for each collection of relevant resources.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • import-orders-controller : Import Orders Controller

2. Resources

2.1. Import-orders-controller

Import Orders Controller

2.1.1. Import Assignment Lots

POST /importOrders/importAssignmentLots
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

importRequestInfo
required

Import assignment lots jobs in JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.2. Import BOM

POST /importOrders/importBOMJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

input
required

Import BOM jobs in JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.3. Import Data Entry Plan

POST /importOrders/importDataEntryPlanJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

importRequestInfo
required

Import Data Entry Plan jobs jobs in JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.4. Import Material

POST /importOrders/importMaterialJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

input
required

Import Material jobs in XML or JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.5. Import MaterialLot

POST /importOrders/importMaterialLotJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

input
required

Import Material Lot jobs in XML or JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.6. Import OSP

POST /importOrders/importOSPJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

input
required

Import OSP jobs in XML or JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.7. Import ProcessOrder

POST /importOrders/importProcessOrderJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

input
required

Import ProcessOrder in XML or JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.8. Import Qualification

POST /importOrders/importQualificationJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

importRequestInfo
required

Import Qualification jobs in JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.9. Import Route

POST /importOrders/importRouteJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

input
required

Import Route in JSON format.

ImportRouteRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.10. Import Tool

POST /importOrders/importToolJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

importRequestInfo
required

Import Tool jobs in JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.11. Import User Qualification

POST /importOrders/importUserQualificationJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

importRequestInfo
required

Import User Qualification jobs in JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.12. Import WorkOrder

POST /importOrders/importWorkOrderJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

input
required

Import Work Order documents in XML or JSON format.

ImportRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal server error

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.13. Get the status of the submitted job

GET /importOrders/importedJobs
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

jobIds
required

Job Ids

< integer (int64) > array(multi)
Responses
HTTP Code Description Schema

200

Ok

OrderResponseInfo

401

Unauthorized

No Content

404

Not found

No Content

500

Internal server error

No Content
Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

2.1.14. Get message of the specified jobId.

GET /importOrders/importedJobs/{jobId}/message
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

jobId
required

jobId

integer (int64)
Responses
HTTP Code Description Schema

200

Ok

ImportJobMessage

401

Unauthorized

No Content

404

Not found

No Content

500

Internal server error

No Content
Produces

  • application/json

  • application/vnd.ge.mes.full+json;version=1.0

Security
Type Name Scopes

oauth2

access_token

default

oauth2

implicit_grant

default

oauth2

resource_owner

default

oauth2

client_creds

default

3. Definitions

3.1. ImportJobMessage

Name Schema

jobId
optional

integer (int64)

message
optional

string

3.2. ImportRequestInfo

Name Description Schema

message
required

ProcessOrderImportMessage

string

3.3. ImportRouteRequestInfo

Name Description Schema

message
required

ProcessOrderImportMessage

string

upgradeSegmentsDocument
optional

boolean

3.4. OrderResponseInfo

Name Schema

jobId
optional

integer (int64)

processCompletionDate
optional

string (date-time)

processStartDate
optional

string (date-time)

responseCode
optional

integer (int32)

responseMessage
optional

string

retryCount
optional

integer (int32)

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. implicit_grant

Type : oauth2
Flow : implicit
Token URL : https://10.181.213.180/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.3. resource_owner

Type : oauth2
Flow : password
Token URL : https://10.181.213.180/uaa/oauth/token

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.