1. Overview
Microservice containing the business logic for managing segments-definition-service.
Descriptions of these functions can be found in the section headers for each collection of relevant resources.
2. Resources
2.1. Segments-definition-controller
Segments Definition Controller
2.1.1. Endpoint for getting all the supported schema versions
GET /blankSegmentsDocuments
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Schema > array |
401 |
Unauthorized |
2.1.2. Endpoint for getting blank Segments document for a given schema version
GET /blankSegmentsDocuments/{schemaVersion}
2.1.3. Endpoint for upgrading Segments document for a given schema version
POST /upgradeSegmentsDocument
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
schemaVersion |
schemaVersion |
integer (int32) |
Body |
schemaDefinition |
schemaDefinition |
object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessible Entity |
2.1.4. Validate segments
POST /validateSegmentsDocument
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
validateSchemaOnly |
True to validate SegmentsSchema. False to validate both Segments schema and content |
boolean |
|
Body |
segmentsDefinition |
segmentsDefinition |
object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
Success |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessible Entity |
|
503 |
Service Unavailable |
3. Definitions
3.1. BillOfMaterialInfo
Bill of Materials of a route.
| Name | Description | Schema |
|---|---|---|
behaviors |
Behaviours of a BOM item |
object |
bomItemId |
Bom Item Id of the material |
integer (int32) |
defaultStorageUnitId |
V8: defaultStorageUnitId of a BOM item |
integer (int32) |
lowerTolerance |
V8: lowerTolerance of a BOM item |
number (double) |
lowerTolerancePrecision |
V8: lowerTolerancePrecision of a BOM item |
integer (int32) |
materialId |
Id of the material |
integer (int32) |
propertyValues |
properties associated to a segment. |
< PropertiesDefInfo > array |
quantity |
Quantity of the material |
number (double) |
quantityPrecision |
V8: quantityPrecision of a BOM item |
integer (int32) |
scrapFactor |
V8: scrapFactor of a BOM item |
object |
unitOfMeasureId |
Id of the unitOfMeasure |
integer (int32) |
upperTolerance |
V8: upperTolerance of a BOM item |
number (double) |
upperTolerancePrecision |
V8: upperTolerancePrecision of a BOM item |
integer (int32) |
visualization |
Visualization of a BOM item |
3.2. BillOfMaterialsBehaviours
Behaviours for Bill of Material of a route.
| Name | Description | Schema |
|---|---|---|
requiresConsumptionTracking |
Boolean property to specify if a BOM item requires consumption acknowledgment/tracking |
boolean |
3.3. BillOfMaterialsVisualization
Behaviours for Bill of Material of a route.
| Name | Description | Schema |
|---|---|---|
displayOrder |
BOM item requires displayOrder |
integer (int32) |
3.4. DocumentInfo
Documents of a route.
| Name | Description | Schema |
|---|---|---|
displayName |
Name of the document |
string |
link |
Link of the document |
string |
3.5. Error
Error details.
| Name | Description | Schema |
|---|---|---|
code |
string |
|
details |
Details of the error. |
object |
3.6. 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.7. OperationsInfo
Operations of a route.
| Name | Description | Schema |
|---|---|---|
id |
Id of the operation |
integer (int64) |
sequenceNumber |
Sequence number of the operation |
integer (int32) |
skipIfSuccessorStarted |
V8: Indicates if implicit skip is enabled |
boolean |
3.8. PropertiesDefInfo
Properties of a route.
| Name | Description | Schema |
|---|---|---|
propertyDefinitionId |
Id of property |
string |
propertyValue |
Value of property |
string |
3.9. RouteSegmentInfo
RouteSegment data tranfer object
| Name | Description | Schema |
|---|---|---|
id |
id of the route Segment |
integer (int64) |
3.11. SegmentInfo
Segment data tranfer object
| Name | Description | Schema |
|---|---|---|
appliesTo |
Qualifiers for operations based on this segment. |
|
behaviors |
Behaviors of a segment |
< string > array |
billOfMaterials |
Bill of materials associated to a segment. |
< BillOfMaterialInfo > array |
description |
Description of the segment. |
string |
documents |
documents associated to a segment. |
< DocumentInfo > array |
id |
id of the route segment |
integer (int64) |
name |
Name of the segment. |
string |
plannedUnitIds |
units associated to a segment. |
< integer (int64) > array |
propertyValues |
properties associated to a segment. |
< PropertiesDefInfo > array |
segmentType |
Type of the segment. Possible options are Segment, Reference |
string |
suggestedLaborTypes |
Labor types to expected on operations for this segment. First value is the default labor type. |
< integer (int64) > array |
3.12. SegmentsAppliesTo
Qualifiers for the segment definition.
| Name | Description | Schema |
|---|---|---|
materialLotActualIds |
Material lot actual(s) that the segment applies to. Applies to all material lot actual(s) if empty. |
< integer (int64) > array |
3.13. SegmentsDefinitionInfo
Segment data tranfer object
| Name | Description | Schema |
|---|---|---|
plannedLineId |
Line Id to which segment document belongs/refers to |
integer (int64) |
producedMaterialId |
produced material Id |
integer (int64) |
schemaVersion |
Version of the segments document. |
integer (int32) |
segments |
List of segments |
< SegmentInfo > array |
structure |
Structure of segments |
|
structureType |
Structure Type of segment. Possible options are Simple, TreeHierarchy |
string |
3.14. StructureInfo
| Name | Description | Schema |
|---|---|---|
operations |
List of operations |
< OperationsInfo > array |
routeSegment |
Route segment details |
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. |