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

  • transformation-controller : Transformation Controller

2. Resources

2.1. Transformation-controller

Transformation Controller

2.1.1. Stores Mapping Specification.

POST /v1/mappingSpecifications
Parameters
Type Name Description Schema

Body

mappingSpecification
required

mappingSpecification

MappingSpecificationCreateInfo
Responses
HTTP Code Description Schema

200

OK

object

201

Created

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. Get Mapping Specifications

GET /v1/mappingSpecifications
Parameters
Type Name Description Schema

Query

messageType
optional

messageType

enum (WorkOrder, Material, ProcessOrder, MaterialLot, Osp)
Responses
HTTP Code Description Schema

200

OK

< MappingSpecificationInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.3. Get Mapping Specification by MappingSpecificationId

GET /v1/mappingSpecifications/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

MappingSpecificationInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.4. Transform the given B2MML/XML to WOID/MMID/POID/MLID/OSP

POST /v1/mappingSpecifications/{id}/transform
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)

Body

b2mml
required

b2mml

string
Responses
HTTP Code Description Schema

200

OK

string

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.5. Transform the given JSON to XML

POST /v1/transform
Parameters
Type Name Description Schema

Body

eventInfo
required

eventInfo

EventInfo
Responses
HTTP Code Description Schema

200

OK

string

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/xml

  • application/json

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. Error

Error details.

Name Description Schema

code
optional

string

details
optional

Details of the error.

object

3.2. EventInfo

EventInfo to transform JSON to XML.

Name Description Schema

eventType
required

Event type

string

message
required

Event Message

string

3.3. HttpErrorResponse

Http Error response.

Name Description Schema

error
optional

Error details

Error

path
optional

URL at which error occured.

string

timestamp
optional

Timestamp at which error occured

string

3.4. MappingSpecificationCreateInfo

Input mapping specification.

Name Description Schema

message
required

Message

string

messageType
required

Message Type. Allowed values are {WorkOrder, Material, ProcessOrder,MaterialLot}

string

3.5. MappingSpecificationInfo

Mapping specification.

Name Description Schema

id
optional

id of the MappingSpecification

integer (int64)

message
required

Message

string

messageType
required

Message Type. Allowed values are {WorkOrder, Material, ProcessOrder,MaterialLot}

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.