erp-export-service

1. Overview

Microservice containing the business logic for managing erp-export-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

export-data-entry-plan-controller : Export Data Entry Plan Controller
export-route-controller : Export Route Controller

2. Resources

2.1. Export-data-entry-plan-controller

Export Data Entry Plan Controller

2.1.1. Get exported of a data entry plan.

GET /exportDataEntryPlans/{dataEntryPlanId}

Parameters

Type	Name	Description	Schema
Header	Site-Id required	Represents the id of the site to connect to	string
Path	dataEntryPlanId required	ID of the data entry plan to export	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

dataEntryPlanId
required

ID of the data entry plan to export

integer (int64)

Responses

HTTP Code	Description	Schema
200	OK	ExportDataInfo
401	Unauthorized	No Content
404	Not Found	HttpErrorResponse
500	Internal Server Error	No Content

HTTP Code

Description

Schema

200

ExportDataInfo

401

Unauthorized

No Content

404

Not Found

HttpErrorResponse

500

Internal Server Error

No Content

Produces

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

Security

Type	Name	Scopes
oauth2	access_token	default
oauth2	resource_owner	default
oauth2	implicit_grant	default
oauth2	client_creds	default

Type

Name

Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2. Export-route-controller

Export Route Controller

2.2.1. Get exported route details.

GET /exportRoutes/{routeId}

Parameters

Type	Name	Description	Schema
Header	Site-Id required	Represents the id of the site to connect to	string
Path	routeId required	routeId	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

routeId
required

routeId

integer (int64)

Responses

HTTP Code	Description	Schema
200	Ok	string
401	Unauthorized	No Content
404	Not found	No Content
500	Internal server error	No Content

HTTP Code

Description

Schema

200

string

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	resource_owner	default
oauth2	implicit_grant	default
oauth2	client_creds	default

Type

Name

Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

3. Definitions

3.1. Error

Error details.

Name	Description	Schema
code optional		string
details optional	Details of the error.	object

Name

Description

Schema

code
optional

string

details
optional

Details of the error.

object

3.2. ExportDataInfo

Name	Description	Schema
content optional	Exported entity in original form	string
contentMediaType optional	Media type of the content	string
exportMetadata optional	Export meta-data to convert exported IDs to local IDs	ExportMetadata

Name

Description

Schema

content
optional

Exported entity in original form

string

contentMediaType
optional

Media type of the content

string

exportMetadata
optional

Export meta-data to convert exported IDs to local IDs

ExportMetadata

3.3. ExportMetadata

Name	Schema
modelProperties optional	< ExportModelProperties > array
sourceProperties optional	< ExportSourceProperties > array

Name

Schema

modelProperties
optional

< ExportModelProperties > array

sourceProperties
optional

< ExportSourceProperties > array

3.4. ExportModelProperties

Name	Schema
propertyName optional	string
propertyValue optional	string

Name

Schema

propertyName
optional

string

propertyValue
optional

string

3.5. ExportSourceProperties

Name	Schema
context optional	object
propertyPath optional	string
sourceName optional	string
sourceValue optional	string
transformation optional	string

Name

Schema

context
optional

object

propertyPath
optional

string

sourceName
optional

string

sourceValue
optional

string

transformation
optional

string

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

Name

Description

Schema

error
optional

Error details

Error

path
optional

URL at which error occured.

string

timestamp
optional

Timestamp at which error occured

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.

Name

Description

default

Default oauth2 scope.

4.2. implicit_grant

Type : oauth2
Flow : implicit
Token URL : http://uaa:8080/uaa=/oauth/authorize

Name	Description
default	Default oauth2 scope.

Name

Description

default

Default oauth2 scope.

4.3. resource_owner

Type : oauth2
Flow : password
Token URL : http://uaa:8080/uaa=/oauth/token

Name	Description
default	Default oauth2 scope.

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.

Name

Description

default

Default oauth2 scope.