Documentation Powered by ReDoc

segments-definition-service (2.0)

Download OpenAPI specification:Download

Microservice containing the business logic for managing segments definition documents.

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

Authentication

OAuth2

Security Scheme Type OAuth2
implicit OAuth Flow
Authorization URL: https://localhost:8443/uaa/oauth/authorize
Scopes:
  • default -

    Default oauth2 scope.

password OAuth Flow
Token URL: https://localhost:8443/uaa/oauth/token
Scopes:
  • default -

    Default oauth2 scope.

authorizationCode OAuth Flow
Authorization URL: https://localhost:8443/uaa/oauth/authorize
Token URL: https://localhost:8443/uaa/oauth/token
Scopes:
  • default -

    Default oauth2 scope.

clientCredentials OAuth Flow
Token URL: https://localhost:8443/uaa/oauth/token
Scopes:
  • default -

    Default oauth2 scope.

bom-formulation-controller

Endpoint for getting all the supported bdd schema versions

Authorizations:
OAuth2
header Parameters
Site-Id
required
string

Represents the id of the site to connect to

Responses

Response samples

Content type
application/vnd.ge.mes.full+json;version=2.0
[
  • {
    }
]

Endpoint for getting blank bdd document for a given schema version

Authorizations:
OAuth2
path Parameters
schemaVersion
required
integer <int32>

Bom formulation schema version

header Parameters
Site-Id
required
string

Represents the id of the site to connect to

Responses

Response samples

Content type
application/vnd.ge.mes.full+json;version=2.0
{ }

segments-definition-controller

Endpoint for upgrading Segments document for a given schema version

Authorizations:
OAuth2
query Parameters
schemaVersion
integer <int32>
bomFormulationId
integer <int64>
header Parameters
Site-Id
required
string

Represents the id of the site to connect to

Request Body schema: application/vnd.ge.mes.full+json;version=2.0
object

Responses

Request samples

Content type
application/vnd.ge.mes.full+json;version=2.0
{ }

Response samples

Content type
application/vnd.ge.mes.full+json;version=2.0
{ }

Endpoint for getting all the supported schema versions

Authorizations:
OAuth2
header Parameters
Site-Id
required
string

Represents the id of the site to connect to

Responses

Response samples

Content type
application/vnd.ge.mes.full+json;version=2.0
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Validate segments

Authorizations:
OAuth2
query Parameters
validateSchemaOnly
boolean
Default: false

True to validate SegmentsSchema. False to validate both Segments schema and content

header Parameters
Site-Id
required
string

Represents the id of the site to connect to

Request Body schema: application/vnd.ge.mes.full+json;version=2.0
object

Responses

Request samples

Content type
application/vnd.ge.mes.full+json;version=2.0
{ }

Response samples

Content type
application/vnd.ge.mes.full+json;version=2.0
{
  • "path": "string",
  • "error": {
    },
  • "message": "string",
  • "timestamp": "string",
  • "status": "string"
}

Endpoint for getting blank Segments document for a given schema version

Authorizations:
OAuth2
path Parameters
schemaVersion
required
integer <int32>

Schema version

header Parameters
Site-Id
required
string

Represents the id of the site to connect to

Responses

Response samples

Content type
application/vnd.ge.mes.full+json;version=2.0
{ }