2. Resources
2.1. Export-route-controller
Export Route Controller
2.1.1. Get Segments Definition Document
GET /export/{routeId}/exportRoute
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
Id of the route |
integer (int64) |
2.2. Export-segment-controller
Export Segment Controller
2.2.1. Get Segments Definition Document
GET /routes/{routeId}/exportSegments
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
routeId |
Get segments of the RouteId |
integer (int64) |
|
Query |
mediaType |
enum (application/json, application/xml) |
|
2.3. Import-route-controller
Import Route Controller
2.3.1. Import route with segmentDefiition
POST /importRoute
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Details of the route to create |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
422 |
Unprocessable Entity |
2.4. Route-command-controller
Route Command Controller
2.4.1. Archive route
PATCH /routes/{routeId}/archive
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
routeId |
integer (int64) |
Body |
routeInfo |
routeInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Un processable Entity |
2.4.2. Get Calculated Labor Plan for a route or operation
GET /routes/{routeId}/calculateLaborPlan
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
routeId |
integer (int64) |
Query |
operationName |
operationName |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Un processable Entity |
2.4.3. Copy route
POST /routes/{routeId}/copyRoute
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
Id of the route to be released |
integer (int64) |
Body |
routeInput |
routeInput |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.4.4. Release route
POST /routes/{routeId}/{confirmRelease}/release
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
confirmRelease |
confirm release flag |
boolean |
|
Path |
routeId |
Id of the route to be released |
integer (int64) |
|
Body |
approvalProcessRequest |
Approval workflow request of the route. Send only if approval is required for release of a route |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Un processable Entity |
|
500 |
Internal Server error |
2.5. Route-controller
Route Controller
2.5.1. Create route
POST /routes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
input |
Details of the route to create |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
422 |
Unprocessable Entity |
2.5.2. Get routes
GET /routes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
bomFormulationId |
bomFormulationId |
integer (int64) |
|
Query |
description |
description |
string |
|
Query |
isPartialSearch |
isPartialSearch |
boolean |
|
Query |
modifiedBy |
modifiedBy |
string |
|
Query |
name |
name |
string |
|
Query |
orderBy |
enum (asc, desc) |
|
|
Query |
orderByColumn |
orderByColumn |
string |
|
Query |
page |
integer (int32) |
|
|
Query |
producedMaterialId |
producedMaterialId |
integer (int64) |
|
Query |
productionLineId |
productionLineId |
integer (int64) |
|
Query |
showAllRevisions |
showAllRevisions |
boolean |
|
Query |
size |
integer (int32) |
|
|
Query |
status |
status |
string |
2.5.3. Get all routes by bomFormulation or material
PATCH /routes/searchroute
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
searchRoutesInfo |
Search routes by bomFormulationIds or producedMaterialIds |
< SearchRoutesInfo > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Route > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
422 |
Unprocessable Entity |
2.5.4. Upgrade route segment documents to latest schema version
GET /routes/upgrade/{schemaVersion}/{routeId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
RouteId of segment |
integer (int64) |
Path |
schemaVersion |
Schema Version |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.5.5. Get a route
GET /routes/{routeId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
Id of the route |
integer (int64) |
2.5.6. Delete a route
DELETE /routes/{routeId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
Route Id to be deleted |
integer (int64) |
2.5.7. Update route
PATCH /routes/{routeId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
Details on the route to update |
integer (int64) |
Body |
routeInfo |
routeInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.5.8. Create a New Revision
POST /routes/{routeId}/revision
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
Id of the route to create a new revision |
integer (int64) |
Body |
routeInput |
routeInput |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.6. Segment-controller
Segment Controller
2.6.1. Get Segments Definition Document
GET /routes/{routeId}/segments
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
routeId |
Get segments of the RouteId |
integer (int64) |
|
Query |
bomFormulationId |
bomFormulationId |
integer (int64) |
|
Query |
isUpdateBOMformulation |
isUpdateBOMformulation |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.6.2. Update segmentDefinition
PUT /routes/{routeId}/segments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
RouteId of segments |
integer (int64) |
Body |
segmentDefInput |
Segments Definition to update |
object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.6.3. Delete segments
DELETE /routes/{routeId}/segments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
RouteId for which segments to be deleted |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
303 |
See Other. (Segments deleted and route segment added) |
|
401 |
Unauthorized |
|
404 |
Not Found |
2.6.4. Get segment
GET /routes/{routeId}/segments/{segmentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
routeId |
RouteId of the segment |
integer (int64) |
Path |
segmentId |
SegmentId fof the segment |
integer (int64) |
3. Definitions
3.1. Api error
Http Error response.
| Name | Schema |
|---|---|
errorCode |
string |
message |
string |
requestPath |
string |
status |
enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED) |
subErrors |
|
timestamp |
string |
3.2. ApiSubError
| Name | Schema |
|---|---|
args |
< string > array |
errorCode |
string |
field |
string |
message |
string |
value |
object |
3.3. ApprovalProcessRequest
Approval process request associated with route release
| Name | Description | Schema |
|---|---|---|
workFlowId |
Approval process workflow id. |
integer (int64) |
3.4. CalculatedLaborPlanCodeInfo
| Name | Schema |
|---|---|
calculatedMachinePlan |
< CalculatedLaborPlanItemInfo > array |
calculatedPeoplePlan |
< CalculatedLaborPlanItemInfo > array |
laborCodeId |
integer (int64) |
laborCodeName |
string |
3.5. CalculatedLaborPlanInfo
| Name | Schema |
|---|---|
revisionNumber |
integer (int32) |
routeId |
integer (int64) |
routeName |
string |
segments |
< CalculatedLaborPlanSegmentInfo > array |
3.6. CalculatedLaborPlanItemInfo
| Name | Schema |
|---|---|
basis |
enum (item, lot) |
laborPlanningTypeId |
integer (int64) |
laborPlanningTypeName |
string |
time |
integer (int64) |
3.7. CalculatedLaborPlanSegmentInfo
| Name | Schema |
|---|---|
plannedUnits |
< CalculatedLaborPlanUnitInfo > array |
segmentId |
integer (int64) |
segmentName |
string |
3.8. CalculatedLaborPlanStandardInfo
| Name | Schema |
|---|---|
machinePlan |
< CalculatedLaborPlanItemInfo > array |
peoplePlan |
< CalculatedLaborPlanItemInfo > array |
3.9. CalculatedLaborPlanUnitInfo
| Name | Schema |
|---|---|
laborCodes |
< CalculatedLaborPlanCodeInfo > array |
standardLaborPlan |
|
unitId |
integer (int64) |
unitName |
string |
3.10. CreateRouteWithSegmentDefintion
| Name | Description | Schema |
|---|---|---|
approvedBy |
approvedBy of the route record |
string |
approvedOn |
approvedOn of the route record |
string (date-time) |
bomFormulationId |
bomFormulationId of the route record |
integer (int64) |
description |
description of the route record |
string |
minorRevision |
minor Revision of the route record |
integer (int32) |
name |
name of the route record |
string |
producedMaterialId |
producedMaterialId of the route record |
integer (int64) |
productionLineId |
productionLineId of the route record |
integer (int64) |
revision |
revision of the route record |
integer (int32) |
segmentsDefinition |
route segmentsDefinition Object |
object |
status |
status of the route record |
string |
3.11. EntityModel«RouteInfo»
| Name | Description | Schema |
|---|---|---|
approvedBy |
User who approved the release of route. |
string |
approvedOn |
Date on which release of route was approved. |
string (date-time) |
bomFormulationId |
bomFormulationId of the route |
integer (int64) |
count |
Determines count of revisions of a route. |
integer (int64) |
createdBy |
User that Created the route. |
string |
createdOn |
Date that the route was created. |
string (date-time) |
description |
description of the route |
string |
lastModifiedBy |
User that last modified the route. |
string |
lastModifiedOn |
Date that the route was last modified. |
string (date-time) |
latest |
Determines if revision of route is latest. 0 - if revision is old. 1 - If revision is new. |
boolean |
links |
< Link > array |
|
maxMinorRevisionNumber |
Determines Max Minor Revision Number revisions of a route. |
integer (int32) |
maxRevisionNumber |
Determines maxRevisionNumber revisions of a route. |
integer (int32) |
minorRevision |
Minor revision of the route |
integer (int32) |
name |
name of the route |
string |
producedMaterialId |
producedMaterialId of the route |
integer (int64) |
productionLineId |
productionLineId of the route |
integer (int64) |
released |
Determines if route been released. 0 - if Route is not released. 1 - If route is released. |
boolean |
revision |
revision of the route |
integer (int32) |
revisionReason |
revision reason of a route |
string |
routeId |
id of the route |
integer (int64) |
state |
State of the route. |
boolean |
status |
status of the route |
string |
3.12. Error
Error details.
| Name | Description | Schema |
|---|---|---|
code |
string |
|
details |
Details of the error. |
object |
3.13. HttpErrorResponse
Http Error response.
| Name | Description | Schema |
|---|---|---|
error |
Error details |
|
path |
URL at which error occured. |
string |
timestamp |
Timestamp at which error occured |
string |
3.14. Link
| Name | Schema |
|---|---|
deprecation |
string |
href |
string |
hreflang |
string |
media |
string |
name |
string |
profile |
string |
rel |
string |
template |
|
templated |
boolean |
title |
string |
type |
string |
3.15. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.16. Route
| Name | Schema |
|---|---|
approvedBy |
string |
approvedOn |
string (date-time) |
bomFormulationId |
integer (int64) |
createdBy |
string |
createdOn |
string (date-time) |
description |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
latest |
boolean |
minorRevision |
integer (int32) |
name |
string |
producedMaterialId |
integer (int64) |
productionLineId |
integer (int64) |
released |
boolean |
revision |
integer (int32) |
revisionReason |
string |
state |
boolean |
status |
string |
version |
integer (int32) |
3.17. RouteForCopyInfo
| Name | Description | Schema |
|---|---|---|
bomFormulationId |
bomFormulationId of the route |
integer (int64) |
description |
description of the route record |
string |
name |
name of the route record |
string |
producedMaterialId |
producedMaterialId of the route record |
integer (int64) |
productionLineId |
productionLineId of the route record |
integer (int64) |
productionUnits |
productionUnits of the route record |
< integer (int64) > array |
revisionReason |
revisionReason of the route record |
string |
secretKey |
secretkey of the BFF request |
string |
3.18. RouteForCreateInfo
Route data to transfer object for creation.
| Name | Description | Schema |
|---|---|---|
bomFormulationId |
bomFormulationId of the route record |
integer (int64) |
description |
description of the route record |
string |
minorRevision |
minor revision of the route record |
integer (int32) |
name |
name of the route record |
string |
producedMaterialId |
producedMaterialId of the route record |
integer (int64) |
productionLineId |
productionLineId of the route record |
integer (int64) |
revision |
revision of the route record |
integer (int32) |
revisionReason |
revision reason of the route record |
string |
secretKey |
secretkey of the BFF request |
string |
status |
status of the route record |
string |
3.19. RouteForStatusUpdateInfo
Route data transfer object for update
| Name | Description | Schema |
|---|---|---|
status |
Status of the route record |
string |
3.20. RouteForUpdateInfo
Route data tranfer object for update
| Name | Description | Schema |
|---|---|---|
bomFormulationId |
bomFormulationId of the route record |
integer (int64) |
description |
Description of the route record |
string |
name |
Name of the route record |
string |
revisionReason |
revisionReason of the route record |
string |
status |
Status of the route record |
string |
3.21. RouteInfo
Route data transfer object
| Name | Description | Schema |
|---|---|---|
approvedBy |
User who approved the release of route. |
string |
approvedOn |
Date on which release of route was approved. |
string (date-time) |
bomFormulationId |
bomFormulationId of the route |
integer (int64) |
count |
Determines count of revisions of a route. |
integer (int64) |
createdBy |
User that Created the route. |
string |
createdOn |
Date that the route was created. |
string (date-time) |
description |
description of the route |
string |
lastModifiedBy |
User that last modified the route. |
string |
lastModifiedOn |
Date that the route was last modified. |
string (date-time) |
latest |
Determines if revision of route is latest. 0 - if revision is old. 1 - If revision is new. |
boolean |
maxMinorRevisionNumber |
Determines Max Minor Revision Number revisions of a route. |
integer (int32) |
maxRevisionNumber |
Determines maxRevisionNumber revisions of a route. |
integer (int32) |
minorRevision |
Minor revision of the route |
integer (int32) |
name |
name of the route |
string |
producedMaterialId |
producedMaterialId of the route |
integer (int64) |
productionLineId |
productionLineId of the route |
integer (int64) |
released |
Determines if route been released. 0 - if Route is not released. 1 - If route is released. |
boolean |
revision |
revision of the route |
integer (int32) |
revisionReason |
revision reason of a route |
string |
routeId |
id of the route |
integer (int64) |
state |
State of the route. |
boolean |
status |
status of the route |
string |
3.22. RouteInfoResult
| Name | Description | Schema |
|---|---|---|
approvedBy |
User who approved the release of route. |
string |
approvedOn |
Date on which release of route was approved. |
string (date-time) |
bomFormulationId |
bomFormulationId of the route |
integer (int64) |
count |
Determines count of revisions of a route. |
integer (int64) |
createdBy |
User that Created the route. |
string |
createdOn |
Date that the route was created. |
string (date-time) |
description |
description of the route |
string |
lastModifiedBy |
User that last modified the route. |
string |
lastModifiedOn |
Date that the route was last modified. |
string (date-time) |
latest |
Determines if revision of route is latest. 0 - if revision is old. 1 - If revision is new. |
boolean |
links |
< Link > array |
|
maxMinorRevisionNumber |
Determines Max Minor Revision Number revisions of a route. |
integer (int32) |
maxRevisionNumber |
Determines maxRevisionNumber revisions of a route. |
integer (int32) |
minorRevision |
Minor revision of the route |
integer (int32) |
name |
name of the route |
string |
producedMaterialId |
producedMaterialId of the route |
integer (int64) |
productionLineId |
productionLineId of the route |
integer (int64) |
released |
Determines if route been released. 0 - if Route is not released. 1 - If route is released. |
boolean |
revision |
revision of the route |
integer (int32) |
revisionReason |
revision reason of a route |
string |
routeId |
id of the route |
integer (int64) |
state |
State of the route. |
boolean |
status |
status of the route |
string |
3.23. RouteInfoResults
| Name | Schema |
|---|---|
content |
< EntityModel«RouteInfo» > array |
links |
< Link > array |
page |
3.24. SearchRoutesInfo
| Name | Schema |
|---|---|
itemType |
string |
resourceIds |
< integer (int64) > array |
3.25. TemplateVariable
| Name | Schema |
|---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.26. UriTemplate
| Name | Schema |
|---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://localhost:8443/uaa/oauth/authorize
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://localhost:8443/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |