1. Overview
It is an orchestration service for non-conformances during production.
1.2. Tags
-
context-type-controller : Context Type Controller
-
defect-controller : Defect Controller
-
defect-history-controller : Defect History Controller
-
defect-type-controller : Defect Type Controller
-
disposition-action-history-controller : Disposition Action History Controller
-
disposition-controller : Disposition Controller
-
disposition-plan-controller : Disposition Plan Controller
-
disposition-type-controller : Disposition Type Controller
-
ncm-patch-controller : NCM Patch Controller
-
non-conformance-controller : Non Conformance Controller
-
non-conformance-type-controller : Non Conformance Type Controller
-
reason-tree-nodes-controller : Reason Tree Nodes Controller
2. Resources
2.1. Context-type-controller
Context Type Controller
2.1.1. Get context type page resource
GET /contexttype
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
201 |
successful |
|
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
404 |
Non-conformance not found |
No Content |
500 |
Internal server error |
No Content |
2.2. Defect-controller
Defect Controller
2.2.1. Create defect on discreate execution
POST /v2/defect-viewer/createDefects
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
successful |
< EntityModel«DefectViewInfo» > array |
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
404 |
Non-conformance not found |
No Content |
500 |
Internal server error |
No Content |
2.2.2. Get defect based on Product Faimily, Product Code, Work Order, Material Lot, Receiver Number, NC Name, Disposition Plan Name
GET /v2/defect-viewer/getDefectQueueSearch
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
defectStatus |
Status of the Defect as a filter Multiple values are supportedand the results contain all operations matching any of the values Available values: Submitted, Planned, Active, Closed, Not a defect Default for product is: Submitted and Active e.i. open defects |
< string > array(multi) |
|
Query |
page |
integer (int32) |
|
|
Query |
searchQueue |
Search text to find defects Supported fields are: Product Family, Product Code, Work Order, Material Lot, Receiver Number, Disposition Plan Name, NC Name |
string |
|
Query |
size |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
2.2.3. getDefects
GET /v2/defect-viewer/getDefects
Caution
|
operation.deprecated |
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
affected_quantity |
Number of Affected_quantity for the defect. |
< number (double) > array(multi) |
|
Query |
id |
ID for the Defect as a filter. |
< integer (int64) > array(multi) |
|
Query |
likeOnColumn |
On column which like operator is affected. |
string |
|
Query |
likeSearchValue |
On column which like search is applied. |
string |
|
Query |
modified_by |
User that last modified the Defect. |
< string > array(multi) |
|
Query |
modified_on |
Date that the Defect was last modified. |
< string > array(multi) |
|
Query |
nonConformanceId |
Id of the NonConformance resource. |
< integer (int64) > array(multi) |
|
Query |
operations |
List of Operation as a filter. |
< string > array(multi) |
|
Query |
orderBy |
enum (asc, desc) |
|
|
Query |
orderByColumn |
Name of the column to sort based on like lastModifiedOn. |
string |
|
Query |
page |
integer (int32) |
|
|
Query |
serialNos |
SerialNumber (e.g. Lot identifier) as a filter. |
< string > array(multi) |
|
Query |
size |
integer (int32) |
|
|
Query |
status |
Status of the Defect as a filter. Multiple values are supported and the results contain all operations matching any of the values Available values : Submitted, Planned, Active, Closed, Not a defect |
< string > array(multi) |
|
Query |
summary |
Summary of the Defect as a filter. |
< string > array(multi) |
|
Query |
workOrders |
List of work order Info as a filter. |
< string > array(multi) |
2.2.4. getDefectsObject
GET /v2/defect-viewer/getDefectsObject/{objectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
objectId |
Object id must be a Work Order Id, Material Lot Actual Id, Segment Actaul Id or Receiving Inspection Production Event Id |
integer (int64) |
|
Query |
object |
object |
enum (MaterialLotActual, WorkOrder, SegmentActual, RI_ProdEventId) |
|
Query |
page |
integer (int32) |
|
|
Query |
size |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
401 |
Unauthorized |
No Content |
412 |
Precondition fail |
No Content |
500 |
Internal server error |
No Content |
503 |
Service unavailable |
No Content |
2.2.5. getOperationsBySearch
GET /v2/defect-viewer/getOperationsBySearch
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
clockedOnOperator |
Currently clocked on operator as a filter. |
string |
Query |
completedAfter |
Filter results to return operations completed on or after this time Combines with CompletedBefore to define a time range. |
string (date-time) |
Query |
completedBefore |
Filter results to return operations completed on or before this time Combines with CompletedAfter to define a time range. |
string (date-time) |
Query |
lotIdentifier |
SerialNumber (e.g. Lot identifier) as a filter. |
string |
Query |
materialLotActualId |
ID of the material lot actual as a filter. |
integer (int64) |
Query |
onHold |
Whether the operation is currently on hold as a filterIf set to true, query will only return operations with active hold records. |
boolean |
Query |
operationName |
Name of the operation as a filter Note that operation names are unique only within a segment definition and not across segment definitions. |
string |
Query |
orderBy |
Name of the operation property to sort the results by. |
string |
Query |
page |
Page number to return 0 to N. |
integer (int32) |
Query |
plannedOrStartedOnUnitId |
for the unit that the operation is executing on OR planned to execute on if the operation is not started as a filter. |
integer (int64) |
Query |
plannedUnitId |
ID for the planned unit as a filter. The results contain all operations that have the ID in the planned unit set The planned unit set is specified in the segment definition. |
integer (int64) |
Query |
producedMaterialId |
ID for the material produced as a filter The material produced is defined by the segments definition for the work order. |
< integer (int64) > array(multi) |
Query |
productionLineId |
ID for the production line as a filter. |
< integer (int64) > array(multi) |
Query |
segmentActualId |
ID for the segment actual as a filter. Multiple values are supported and the results contain all operations matching any of the values. |
< integer (int64) > array(multi) |
Query |
segmentId |
ID for the segment as a filter. Note that segment IDs are unique only within a segment definition and not across segment definitions. |
integer (int64) |
Query |
size |
Number of resources to return per page. |
integer (int32) |
Query |
startedOnUnitId |
ID for the unit that the segment is executing on as a filter. |
integer (int64) |
Query |
status |
Status of the operation as a filter. Multiple values are supported and the results contain all operations matching any of the values Available values : NotReady, Ready, InProgress, Complete, Cancelled |
< string > array(multi) |
Query |
workOrderId |
ID for the work order as a filter. |
integer (int64) |
Query |
workOrderName |
Name of the work order as a filter. |
string |
Query |
workOrderPriority |
Relative priority of the work order as a filter. |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Non-conformance not found |
No Content |
500 |
Failure |
No Content |
2.2.6. updateDefect
PUT /v2/defect-viewer/updateDefects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
defectId |
Defect Id of defect |
integer (int64) |
Query |
nonConformanceId |
Nonconformance Id of defect to be update |
integer (int64) |
Body |
requestBody |
Required information to be updated in defects |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
412 |
Defect has been updated since the GET on which the submitted changes were made Response contains the current record. |
No Content |
500 |
Internal server error |
No Content |
2.2.7. Create defect for receiving inspection
POST /v2/defect-viewer/{contextid}/createdefects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
contextid |
context id for receiving inspection |
integer (int64) |
Body |
defect |
Required information to create defects |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
successful |
< EntityModel«DefectViewInfo» > array |
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
404 |
Non-conformance not found |
No Content |
500 |
Internal server error |
No Content |
2.2.8. getDispositionActions
GET /v2/defect-viewer/{defectId}/dispositionActions
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
defectId |
ID of the Defect as a filter. |
integer (int64) |
Query |
nonConformanceId |
ID of the Nonconformance as a filter. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< DispositionActionResource > array |
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
2.2.9. getMateriallotactualsObject
GET /v2/defect-viewer/{workOrderId}/materiallotactuals
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
workOrderId |
Id of the work order resource |
integer (int64) |
Query |
parentMaterialLotActualId |
ID for the parent material lot actual as a filter. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
< string > array |
401 |
Unauthorized |
No Content |
412 |
Precondition fail |
No Content |
500 |
Internal server error |
No Content |
503 |
Service unavailable |
No Content |
2.3. Defect-history-controller
Defect History Controller
2.3.1. getDefectHistory
GET /v1/defect-history/{defectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
defectId |
defectId |
integer (int64) |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
2.4. Defect-type-controller
Defect Type Controller
2.4.1. getDefectTypes
GET /v1/defect-types-viewer
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
pageNo |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.5. Disposition-action-history-controller
Disposition Action History Controller
2.5.1. getDispositionActionHistory
GET /v2/dispositionActionHistory-viewer/getDispositionActionHistory/{nonConformanceId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
nonConformanceId |
Object id must be a non-conformance Id |
integer (int64) |
|
Query |
page |
integer (int32) |
|
|
Query |
size |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
401 |
Unauthorized |
No Content |
412 |
Precondition fail |
No Content |
500 |
Internal server error |
No Content |
503 |
Service unavailable |
No Content |
2.6. Disposition-controller
Disposition Controller
2.6.1. createDisposition
POST /v2/disposition/createDisposition
Caution
|
operation.deprecated |
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
dispositionPlanId |
Id of the dispositionPlan resource. |
integer (int64) |
Body |
disposition |
DispositionAction Details information to create dispositionAction. |
2.6.2. Create disposition for discrete execution
POST /v2/disposition/createDispositions
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
nonSerializedDispositionInfoExtend |
Split and DispositionAction details to split the lots and create dispositionAction on them. |
< NonSerializedDispositionInfoExtend > array |
2.6.3. Create Empty Disposition Actions
POST /v2/disposition/createEmptyDispositionActions
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
dispositionPlanDefectIdDto |
DispositionAction Details to create empty dispositionAction. |
2.6.4. Update CTP for Discrete Execution
PUT /v2/disposition/editCTP
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
dispositionPlanId |
ID for the dispositionPlan as a filter for edit dispositionActions. |
integer (int64) |
Body |
disposition |
Disposition Details to edit Continue to process(CTP). |
2.6.5. Update Disposition for Discrete Execution
PUT /v2/disposition/updateDisposition
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
dispositionPlanId |
Id of the dispositionPlan resource to update. |
integer (int64) |
Query |
previousDisposition |
Previous disposition done on the defect which will be updated with the given disposition. Currently applicable to MRB only, for updating CTP use edit CTP endpoint |
string |
Body |
disposition |
DispositionAction Details information to Update dispositionAction. |
2.6.6. Update disposition for receiving inspection
PUT /v2/disposition/updateReceivingInspectionDispositionAction
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
updateReceivingInspectionInfo |
DispositionAction Details information to update dispositionAction for Receiving Inspection App |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
201 |
successful |
|
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
404 |
Non-conformance not found |
No Content |
500 |
Internal server error |
No Content |
2.6.7. Check disposition is possible in same plan or not for Discrete Execution
POST /v2/disposition/validatefordisposition
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
dispositionPlanId |
ID for the dispositionPlan as a filter for Validate dispositionActions. |
integer (int64) |
Body |
defectSerialNoInfo |
List of Details about defectSerialNumber. |
< DefectSerialNoInfo > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Validation Success |
< string, string > map |
401 |
Unauthorized |
No Content |
404 |
Not found, work order id or operation id |
No Content |
422 |
Validation Fail |
No Content |
500 |
Internal Server Error |
No Content |
2.6.8. Create disposition for receiving inspection
POST /v2/disposition/{contextid}/createDisposition
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
contextid |
context id for receiving inspection |
integer (int64) |
Body |
nonSerializedDispositionInfoExtend |
DispositionAction Details information to create dispositionAction for Receiving Inspection App |
< RINonSerializedDispositionInfoExtend > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
201 |
successful |
|
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
404 |
Non-conformance not found |
No Content |
500 |
Internal server error |
No Content |
2.6.9. getDispositionActionByDefectId
GET /v2/disposition/{nonconformanceId}/{defectId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
defectId |
ID of the Defect as a filter. |
integer (int64) |
Path |
nonconformanceId |
ID of the NonconformanceId as a filter. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< DispositionActionViewInfo > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
2.7. Disposition-plan-controller
Disposition Plan Controller
2.7.1. createDispositionPlan
POST /v2/dispositionplans
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
record |
Details about DispositionPlan to create. |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Invalid data supplied: must not set dispositionPlanId property |
No Content |
401 |
Unauthorized |
No Content |
2.7.2. getAllDispositionPlans
GET /v2/dispositionplans
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
dispositionActionStatus |
Details of DispositionPlan Information as a filter If set to All query will only return all operations,If you set Open query will only return open Plans. |
enum (Open, All) |
|
Query |
pageNo |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.8. Disposition-type-controller
Disposition Type Controller
2.8.1. getDispositionTypes
GET /v1/disposition-type-viewer
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
contextid |
Context Id for Disposition Type |
integer (int64) |
|
Query |
pageNo |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.8.2. getOperations
GET /v1/disposition-type-viewer/getOperations
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
workOrderId |
List of all Operations for the specific workOrder Id. |
integer (int64) |
2.9. Ncm-patch-controller
NCM Patch Controller
2.9.1. modifyDispositionPlan
PATCH /ncmpatch/modifydispositionplan
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
disposition |
Details on the DispositionPlan to Update. |
< DispositionPatch > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
2.10. Non-conformance-controller
Non Conformance Controller
2.10.1. createNonConfromance
POST /v1/nonconformance-viewer
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
nonConformance |
NonConfromance Details to create. |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Invalid data supplied: must not set nonConformanceId property |
No Content |
401 |
Unauthorized |
No Content |
404 |
Parent ncr-type not found. |
No Content |
2.10.2. getNonConformances
GET /v1/nonconformance-viewer/getNonConformances
Parameters
Type | Name | Schema | Default |
---|---|---|---|
Query |
page |
integer (int32) |
|
Query |
size |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< EntityModel«NonConformanceViewInfo» > array |
400 |
bad Requuest. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
2.11. Non-conformance-type-controller
Non Conformance Type Controller
2.11.1. getNonConformanceTypes
GET /v1/nonconformance-types-viewer
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
paze |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.12. Reason-tree-nodes-controller
Reason Tree Nodes Controller
2.12.1. reasonTreeConfiguration
GET /v1/treenodes-viewer
2.12.2. getReasonTreeNodes
GET /v1/treenodes-viewer/{id}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
Id of the ReasonTreeNodes resource. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< ReasonTreeNodeDto > array |
401 |
Unauthorized |
No Content |
3. Definitions
3.1. BillOfMaterialInfo
Bill of Materials of a route.
Name | Description | Schema |
---|---|---|
materialClass |
Material Class |
string |
materialId |
Id of the material |
integer (int32) |
quantity |
Quantity of the material |
integer (int32) |
uom |
Units of Measure of material |
string |
3.2. BomItem
Name | Schema |
---|---|
bomItemId |
integer (int64) |
bomReallocationQuantity |
< integer (int64) > array |
3.3. ClockOnRecordViewer
Name | Schema |
---|---|
clockOffTime |
string (date-time) |
clockOnTime |
string (date-time) |
clockedOn |
boolean |
id |
integer (int64) |
loggedInUser |
boolean |
operator |
string |
3.4. ContextType
Name | Description | Schema |
---|---|---|
createdBy |
string |
|
createdOn |
string (date-time) |
|
deleted |
Example : |
boolean |
displayName |
string |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
name |
string |
|
version |
integer (int32) |
3.5. ContextTypePage
Name | Schema |
---|---|
content |
< ContextTypeResource > array |
links |
< Link > array |
page |
3.6. ContextTypeResource
Name | Description | Schema |
---|---|---|
contextTypeId |
integer (int64) |
|
createdBy |
string |
|
createdOn |
string (date-time) |
|
displayName |
string |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
links |
< Link > array |
|
name |
string |
|
requiresReview |
Example : |
boolean |
version |
integer (int32) |
3.7. DefectDTO
Name | Schema |
---|---|
affectedObjectType |
string |
defectContextType |
string |
defectReasonLevel1Id |
string |
defectReasonLevel2Id |
string |
defectReasonLevel3Id |
string |
defectReasonLevel4Id |
string |
defectTypeId |
integer (int64) |
description |
string |
locationType |
string |
ncmTypeId |
integer (int64) |
summary |
string |
workOrder |
< WorkOrderInfo > array |
3.8. DefectHistoryViewInfo
Name | Description | Schema |
---|---|---|
affectedObjectId |
string |
|
affectedObjectType |
string |
|
affectedQuantity |
Maximum value : |
number (double) |
affectedQuantityUnitOfMeasure |
string |
|
commentId |
string |
|
createdBy |
string |
|
createdOn |
string (date-time) |
|
defectCauseTreeId |
string |
|
defectContextType |
string |
|
defectHistoryId |
integer (int64) |
|
defectId |
integer (int64) |
|
defectReasonLevel1Id |
string |
|
defectReasonLevel1Name |
string |
|
defectReasonLevel2Id |
string |
|
defectReasonLevel2Name |
string |
|
defectReasonLevel3Id |
string |
|
defectReasonLevel3Name |
string |
|
defectReasonLevel4Id |
string |
|
defectReasonLevel4Name |
string |
|
defectTypeId |
integer (int64) |
|
defectTypeName |
string |
|
description |
string |
|
dispositionActionTreeId |
string |
|
dispositionActions |
< DispositionActionHistoryViewInfo > array |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
locationId |
string |
|
locationName |
string |
|
locationType |
string |
|
materialLotActualId |
integer (int64) |
|
materialLotActualStatus |
string |
|
modifiedOn |
string (date-time) |
|
nonConformanceId |
integer (int64) |
|
nonConformanceType |
string |
|
nonConformanceTypeId |
integer (int64) |
|
nonconformanceDescription |
string |
|
nonconformanceName |
string |
|
operation |
string |
|
operationId |
integer (int64) |
|
product |
||
productFamily |
||
propertyValues |
< PropertyValueInfo > array |
|
reportedBy |
string |
|
serialNumber |
string |
|
status |
string |
|
summary |
string |
|
version |
integer (int32) |
|
workOrder |
string |
|
workOrderId |
integer (int64) |
|
workOrderInfo |
< WorkOrderInfo > array |
3.9. DefectInfoExtend
Name | Schema |
---|---|
affectedObjectId |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel2Id |
string |
defectReasonLevel3Id |
string |
defectReasonLevel4Id |
string |
defectTypeId |
integer (int64) |
description |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
locationId |
string |
locationType |
string |
nonconformanceId |
integer (int64) |
propertyValues |
< PropertyValueExtend > array |
reportedBy |
string |
status |
string |
summary |
string |
version |
integer (int32) |
3.10. DefectNCMIdDto
Name | Schema |
---|---|
defectId |
integer (int64) |
nonConformanceId |
integer (int64) |
3.11. DefectSerialNoInfo
Name | Schema |
---|---|
currentoperationId |
integer (int64) |
defectId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionTypeId |
integer (int64) |
materialLotActualId |
integer (int64) |
nonConformanceId |
integer (int64) |
operationId |
integer (int64) |
segmentActualId |
integer (int64) |
serialNumber |
string |
workOrderId |
integer (int64) |
3.12. DefectTypeViewInfo
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
dispositionActionTreeId |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
version |
integer (int32) |
3.13. DefectViewInfo
Name | Schema |
---|---|
affectedObjectId |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
appliedSearchOn |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectContextType |
string |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel1Name |
string |
defectReasonLevel2Id |
string |
defectReasonLevel2Name |
string |
defectReasonLevel3Id |
string |
defectReasonLevel3Name |
string |
defectReasonLevel4Id |
string |
defectReasonLevel4Name |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
description |
string |
dispositionActionTreeId |
string |
dispositionActions |
< DispositionActionViewInfo > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
locationId |
string |
locationName |
string |
locationType |
string |
materialLotActualId |
integer (int64) |
materialLotActualStatus |
string |
ncLastModifiedBy |
string |
ncLastModifiedOn |
string (date-time) |
nonConformanceType |
string |
nonconformanceDescription |
string |
nonconformanceId |
integer (int64) |
nonconformanceName |
string |
nonconformanceTypeId |
integer (int64) |
operation |
string |
operationId |
integer (int64) |
product |
|
productFamily |
|
propertyValues |
< PropertyValueInfo > array |
receiverId |
integer (int64) |
receiverNumber |
string |
reportedBy |
string |
serialNumber |
string |
status |
string |
summary |
string |
version |
integer (int32) |
workOrder |
string |
workOrderId |
integer (int64) |
3.14. DispositionActionHistoryViewInfo
Name | Schema |
---|---|
actionNote |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel1Name |
string |
daReasonLevel2Id |
string |
daReasonLevel2Name |
string |
daReasonLevel3Id |
string |
daReasonLevel3Name |
string |
daReasonLevel4Id |
string |
daReasonLevel4Name |
string |
defectId |
integer (int64) |
dispositionActionHistoryId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionActionPropertyValues |
< PropertyValueInfo > array |
dispositionPlan |
|
dispositionPlanId |
integer (int64) |
dispositionType |
|
dispositionTypeId |
integer (int64) |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
materialLotActualId |
integer (int64) |
materialLotActualStatus |
string |
modifiedOn |
string (date-time) |
name |
string |
operation |
string |
operationId |
integer (int64) |
product |
|
productFamily |
|
quantity |
number (double) |
serialNumber |
string |
status |
string |
version |
integer (int32) |
workOrder |
string |
workOrderId |
integer (int64) |
3.15. DispositionActionInfoExtend
Name | Schema |
---|---|
actionNote |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel2Id |
string |
daReasonLevel3Id |
string |
daReasonLevel4Id |
string |
dispositionActionId |
integer (int64) |
dispositionPlanId |
integer (int64) |
dispositionType |
string |
elapsedTime |
integer (int32) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
properties |
< PropertyValueExtend > array |
quantity |
number (double) |
status |
string |
version |
integer (int32) |
3.16. DispositionActionResource
Name | Schema |
---|---|
actionNote |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel2Id |
string |
daReasonLevel3Id |
string |
daReasonLevel4Id |
string |
dispositionActionId |
integer (int64) |
dispositionPlan |
|
dispositionPlanId |
integer (int64) |
dispositionTypeId |
integer (int64) |
dispositionTypeName |
string |
dispositionTypeNameGlobal |
string |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
links |
< Link > array |
name |
string |
parentId |
integer (int64) |
properties |
< PropertyValueInfo > array |
quantity |
number (double) |
status |
string |
version |
integer (int32) |
3.17. DispositionActionViewInfo
Name | Schema |
---|---|
actionNote |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel1Name |
string |
daReasonLevel2Id |
string |
daReasonLevel2Name |
string |
daReasonLevel3Id |
string |
daReasonLevel3Name |
string |
daReasonLevel4Id |
string |
daReasonLevel4Name |
string |
dispositionActionId |
integer (int64) |
dispositionPlan |
|
dispositionType |
string |
dispositionTypeId |
integer (int64) |
dispositionTypeNameGlobal |
string |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
materialLotActualId |
integer (int64) |
materialLotActualStatus |
string |
name |
string |
operation |
string |
operationId |
integer (int64) |
product |
|
productFamily |
|
properties |
< PropertyValueInfo > array |
quantity |
number (double) |
segmentActualId |
integer (int64) |
serialNumber |
string |
status |
string |
version |
integer (int32) |
workOrder |
string |
workOrderId |
integer (int64) |
3.18. DispositionInfoExtend
Name | Schema |
---|---|
defectSerialNoInfo |
< DefectSerialNoInfo > array |
dispositionAction |
|
dispositionPlan |
|
futureOrReworkOperations |
< OperationInfo > array |
3.19. DispositionPatch
Name | Schema |
---|---|
defectId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionPlanId |
integer (int64) |
nonconformanceId |
integer (int64) |
3.20. DispositionPlanDefectIdDto
Name | Schema |
---|---|
defectNCMIds |
< DefectNCMIdDto > array |
dispositionPlanBody |
3.21. DispositionPlanInfo
Name | Description | Schema |
---|---|---|
createdBy |
string |
|
createdOn |
string (date-time) |
|
dispositionPlanId |
integer (int64) |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
name |
string |
|
parentId |
integer (int64) |
|
requiresReview |
Example : |
boolean |
reviewed |
Example : |
boolean |
reviewedBy |
string |
|
reviewedOn |
string (date-time) |
|
source |
string |
|
status |
string |
|
version |
integer (int32) |
3.22. DispositionPlanInfoExtend
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionPlanId |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
requiresReview |
boolean |
reviewed |
boolean |
reviewedBy |
string |
reviewedOn |
string (date-time) |
source |
string |
version |
integer (int32) |
3.23. DispositionPlanViewInfo
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionPlanId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
requiresReview |
boolean |
reviewed |
boolean |
reviewedBy |
string |
reviewedOn |
string (date-time) |
source |
string |
version |
integer (int32) |
3.24. DispositionTypeInfo
Name | Description | Schema |
---|---|---|
contextType |
< ContextType > array |
|
createdBy |
string |
|
createdOn |
string (date-time) |
|
dispositionTypeId |
integer (int64) |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
name |
string |
|
nameGlobal |
string |
|
parentId |
integer (int64) |
|
requiresReview |
Example : |
boolean |
version |
integer (int32) |
3.25. DispositionTypeViewInfo
Name | Schema |
---|---|
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
name |
string |
nameGlobal |
string |
requiresReview |
boolean |
3.26. DocumentInfo
Documents of a route.
Name | Description | Schema |
---|---|---|
link |
Link of the document |
string |
name |
Name of the document |
string |
3.27. EntityModel«DefectHistoryViewInfo»
Name | Description | Schema |
---|---|---|
affectedObjectId |
string |
|
affectedObjectType |
string |
|
affectedQuantity |
Maximum value : |
number (double) |
affectedQuantityUnitOfMeasure |
string |
|
commentId |
string |
|
createdBy |
string |
|
createdOn |
string (date-time) |
|
defectCauseTreeId |
string |
|
defectContextType |
string |
|
defectHistoryId |
integer (int64) |
|
defectId |
integer (int64) |
|
defectReasonLevel1Id |
string |
|
defectReasonLevel1Name |
string |
|
defectReasonLevel2Id |
string |
|
defectReasonLevel2Name |
string |
|
defectReasonLevel3Id |
string |
|
defectReasonLevel3Name |
string |
|
defectReasonLevel4Id |
string |
|
defectReasonLevel4Name |
string |
|
defectTypeId |
integer (int64) |
|
defectTypeName |
string |
|
description |
string |
|
dispositionActionTreeId |
string |
|
dispositionActions |
< DispositionActionHistoryViewInfo > array |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
links |
< Link > array |
|
locationId |
string |
|
locationName |
string |
|
locationType |
string |
|
materialLotActualId |
integer (int64) |
|
materialLotActualStatus |
string |
|
modifiedOn |
string (date-time) |
|
nonConformanceId |
integer (int64) |
|
nonConformanceType |
string |
|
nonConformanceTypeId |
integer (int64) |
|
nonconformanceDescription |
string |
|
nonconformanceName |
string |
|
operation |
string |
|
operationId |
integer (int64) |
|
product |
||
productFamily |
||
propertyValues |
< PropertyValueInfo > array |
|
reportedBy |
string |
|
serialNumber |
string |
|
status |
string |
|
summary |
string |
|
version |
integer (int32) |
|
workOrder |
string |
|
workOrderId |
integer (int64) |
|
workOrderInfo |
< WorkOrderInfo > array |
3.28. EntityModel«DefectTypeViewInfo»
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
dispositionActionTreeId |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
version |
integer (int32) |
3.29. EntityModel«DefectViewInfo»
Name | Schema |
---|---|
affectedObjectId |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
appliedSearchOn |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectContextType |
string |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel1Name |
string |
defectReasonLevel2Id |
string |
defectReasonLevel2Name |
string |
defectReasonLevel3Id |
string |
defectReasonLevel3Name |
string |
defectReasonLevel4Id |
string |
defectReasonLevel4Name |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
description |
string |
dispositionActionTreeId |
string |
dispositionActions |
< DispositionActionViewInfo > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
locationId |
string |
locationName |
string |
locationType |
string |
materialLotActualId |
integer (int64) |
materialLotActualStatus |
string |
ncLastModifiedBy |
string |
ncLastModifiedOn |
string (date-time) |
nonConformanceType |
string |
nonconformanceDescription |
string |
nonconformanceId |
integer (int64) |
nonconformanceName |
string |
nonconformanceTypeId |
integer (int64) |
operation |
string |
operationId |
integer (int64) |
product |
|
productFamily |
|
propertyValues |
< PropertyValueInfo > array |
receiverId |
integer (int64) |
receiverNumber |
string |
reportedBy |
string |
serialNumber |
string |
status |
string |
summary |
string |
version |
integer (int32) |
workOrder |
string |
workOrderId |
integer (int64) |
3.30. EntityModel«DispositionActionHistoryViewInfo»
Name | Schema |
---|---|
actionNote |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel1Name |
string |
daReasonLevel2Id |
string |
daReasonLevel2Name |
string |
daReasonLevel3Id |
string |
daReasonLevel3Name |
string |
daReasonLevel4Id |
string |
daReasonLevel4Name |
string |
defectId |
integer (int64) |
dispositionActionHistoryId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionActionPropertyValues |
< PropertyValueInfo > array |
dispositionPlan |
|
dispositionPlanId |
integer (int64) |
dispositionType |
|
dispositionTypeId |
integer (int64) |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
links |
< Link > array |
materialLotActualId |
integer (int64) |
materialLotActualStatus |
string |
modifiedOn |
string (date-time) |
name |
string |
operation |
string |
operationId |
integer (int64) |
product |
|
productFamily |
|
quantity |
number (double) |
serialNumber |
string |
status |
string |
version |
integer (int32) |
workOrder |
string |
workOrderId |
integer (int64) |
3.31. EntityModel«DispositionPlanViewInfo»
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionPlanId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
requiresReview |
boolean |
reviewed |
boolean |
reviewedBy |
string |
reviewedOn |
string (date-time) |
source |
string |
version |
integer (int32) |
3.32. EntityModel«DispositionTypeViewInfo»
Name | Schema |
---|---|
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
links |
< Link > array |
name |
string |
nameGlobal |
string |
requiresReview |
boolean |
3.33. EntityModel«NonConformanceTypeViewInfo»
Name | Schema |
---|---|
deleted |
boolean |
description |
string |
id |
integer (int64) |
links |
< Link > array |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
3.34. EntityModel«NonConformanceViewInfo»
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
defectInfo |
< DefectViewInfo > array |
description |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
nonConformanceId |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
string |
source |
string |
status |
string |
version |
integer (int32) |
3.35. EntityModel«OperationViewer»
Name | Description | Schema |
---|---|---|
clockedOnRecords |
Clocked on users |
< ClockOnRecordViewer > array |
clockedStatus |
Clocked On User status clockedStatus |
string |
completedBy |
Completed user |
string |
completedOn |
Completed Operation time |
string (date-time) |
completedQuantity |
completed Quantity |
integer (int32) |
holdOn |
OnHold Operation time |
string (date-time) |
id |
integer (int64) |
|
links |
< Link > array |
|
lotIdentifier |
Lot name of the order |
string |
lotPlannedQuantity |
lot Planned Quantity |
integer (int32) |
materialLotActualId |
Lot id of the order |
integer (int64) |
onHold |
On Hold state of the Operation |
boolean |
onHoldBy |
OnHold user |
string |
operationName |
Segment Identifier of the work order |
string |
plannedUnitIds |
Operation planned on Units |
< integer (int64) > array |
product |
Product detail associated with workorder |
|
productId |
Product id of the workorder |
integer (int64) |
segmentActualId |
Segment actual id |
integer (int64) |
segmentId |
Segment id of the work order |
integer (int64) |
segmentStatus |
Segment status |
string |
startedOn |
startedOn Operation time |
string (date-time) |
startedOnUnitId |
Operation Started on Unit |
integer (int64) |
workOrderId |
Id of work order |
integer (int64) |
workOrderName |
Name of the work order |
string |
workOrderPriority |
Priority of the work order |
integer (int32) |
3.36. Link
Name | Description | Schema |
---|---|---|
href |
string |
|
rel |
string |
|
templated |
Example : |
boolean |
3.37. NonConformanceInfoExtend
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
description |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
nonConformanceId |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
source |
string |
version |
integer (int32) |
3.38. NonConformanceTypeViewInfo
Name | Schema |
---|---|
deleted |
boolean |
description |
string |
id |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
3.39. NonConformanceViewInfo
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
defectInfo |
< DefectViewInfo > array |
description |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
nonConformanceId |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
string |
source |
string |
status |
string |
version |
integer (int32) |
3.40. NonSerializedDispositionInfoExtend
Name | Schema |
---|---|
defectSerialNoInfo |
|
dispositionPlanId |
integer (int64) |
newLotIdentifier |
string |
splitChildDispositionInfo |
< SplitChildDispositionInfoExtend > array |
totalQuantity |
integer (int32) |
3.42. OperationViewer
Name | Description | Schema |
---|---|---|
clockedOnRecords |
Clocked on users |
< ClockOnRecordViewer > array |
clockedStatus |
Clocked On User status clockedStatus |
string |
completedBy |
Completed user |
string |
completedOn |
Completed Operation time |
string (date-time) |
completedQuantity |
completed Quantity |
integer (int32) |
holdOn |
OnHold Operation time |
string (date-time) |
id |
integer (int64) |
|
lotIdentifier |
Lot name of the order |
string |
lotPlannedQuantity |
lot Planned Quantity |
integer (int32) |
materialLotActualId |
Lot id of the order |
integer (int64) |
onHold |
On Hold state of the Operation |
boolean |
onHoldBy |
OnHold user |
string |
operationName |
Segment Identifier of the work order |
string |
plannedUnitIds |
Operation planned on Units |
< integer (int64) > array |
product |
Product detail associated with workorder |
|
productId |
Product id of the workorder |
integer (int64) |
segmentActualId |
Segment actual id |
integer (int64) |
segmentId |
Segment id of the work order |
integer (int64) |
segmentStatus |
Segment status |
string |
startedOn |
startedOn Operation time |
string (date-time) |
startedOnUnitId |
Operation Started on Unit |
integer (int64) |
workOrderId |
Id of work order |
integer (int64) |
workOrderName |
Name of the work order |
string |
workOrderPriority |
Priority of the work order |
integer (int32) |
3.43. OperationsInfo
Operations of a route.
Name | Description | Schema |
---|---|---|
id |
Id of the operation |
integer (int64) |
sequenceNumber |
Sequence number of the operation |
integer (int32) |
3.44. PageMetadata
Name | Schema |
---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.45. PagedModel«EntityModel«DefectHistoryViewInfo»»
Name | Schema |
---|---|
content |
< EntityModel«DefectHistoryViewInfo» > array |
links |
< Link > array |
page |
3.46. PagedModel«EntityModel«DefectTypeViewInfo»»
Name | Schema |
---|---|
content |
< EntityModel«DefectTypeViewInfo» > array |
links |
< Link > array |
page |
3.47. PagedModel«EntityModel«DefectViewInfo»»
Name | Schema |
---|---|
content |
< EntityModel«DefectViewInfo» > array |
links |
< Link > array |
page |
3.48. PagedModel«EntityModel«DispositionActionHistoryViewInfo»»
Name | Schema |
---|---|
content |
|
links |
< Link > array |
page |
3.49. PagedModel«EntityModel«DispositionPlanViewInfo»»
Name | Schema |
---|---|
content |
< EntityModel«DispositionPlanViewInfo» > array |
links |
< Link > array |
page |
3.50. PagedModel«EntityModel«DispositionTypeViewInfo»»
Name | Schema |
---|---|
content |
< EntityModel«DispositionTypeViewInfo» > array |
links |
< Link > array |
page |
3.51. PagedModel«EntityModel«NonConformanceTypeViewInfo»»
Name | Schema |
---|---|
content |
< EntityModel«NonConformanceTypeViewInfo» > array |
links |
< Link > array |
page |
3.52. PagedModel«EntityModel«OperationViewer»»
Name | Schema |
---|---|
content |
< EntityModel«OperationViewer» > array |
links |
< Link > array |
page |
3.53. Product
Name | Description | Schema |
---|---|---|
code |
The product code |
string |
description |
The description of the product |
string |
descriptionGlobal |
The description of the product global |
string |
eventEsignatureLevel |
The event Esiganature level |
integer (int64) |
externalLink |
Product External Link |
string |
id |
The unique ID of the product |
integer (int64) |
isSerialized |
The product Id is serialized or not |
boolean |
links |
< Link > array |
|
productChangeEsignatureLevel |
The product change Esiganature level |
integer (int64) |
productFamilyId |
The id of the product family this product is a member of |
integer (int64) |
productGroupId |
The id of the product group this product is a member of |
integer (int64) |
3.54. ProductFamily
Name | Description | Schema |
---|---|---|
description |
The product family’s description |
string |
id |
The unique Id of the product family |
integer (int64) |
links |
< Link > array |
3.55. PropertiesDefInfo
Properties of a route.
Name | Description | Schema |
---|---|---|
propertyDefinitionId |
Id of property |
integer (int32) |
propertyValue |
Value of property |
string |
templateId |
TemplateId of the property |
integer (int32) |
3.56. PropertyValueExtend
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
originId |
integer (int64) |
propertyDefinitionId |
string |
propertyValueId |
integer (int64) |
value |
string |
version |
integer (int32) |
3.57. PropertyValueInfo
Name | Schema |
---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionActionHistoryId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
originId |
integer (int64) |
parentId |
integer (int64) |
propertyDefinitionId |
string |
propertyValueId |
integer (int64) |
value |
string |
version |
integer (int32) |
3.58. RINonSerializedDispositionInfoExtend
Name | Schema |
---|---|
defectSerialNoInfo |
|
dispositionPlanId |
integer (int64) |
newLotIdentifier |
string |
riSplitChildDispositionInfoExtend |
< RISplitChildDispositionInfoExtend > array |
totalQuantity |
integer (int32) |
3.59. RISplitChildDispositionInfoExtend
Name | Schema |
---|---|
dispositionAction |
|
dispositionPlan |
|
dispositionTypeId |
integer (int64) |
3.60. ReasonTreeNodeDto
Name | Description | Schema |
---|---|---|
categoryId |
The categoryId of the reason |
integer (int64) |
categoryName |
The category name of reason |
string |
children |
The List of the reasonTreeNode |
< ReasonTreeNodeDto > array |
links |
< Link > array |
|
nodeId |
The Unique identifier of node |
integer (int64) |
parentNodeId |
The Unique identifier of parentNode |
integer (int64) |
reasonId |
The Unique identifier of reason |
integer (int64) |
reasonLevel |
The level can be 1-level1 2-level2 3-level3 4-level4 of reason |
integer (int32) |
reasonName |
The name of the reason |
string |
treeId |
The Unique identifier of tree |
integer (int64) |
3.61. RouteSegmentInfo
RouteSegment data tranfer object
Name | Description | Schema |
---|---|---|
id |
id of the route Segment |
integer (int64) |
3.62. SegmentInfo
Segment data tranfer object
Name | Description | Schema |
---|---|---|
billOfMaterials |
List of BillOfMaterials for an operation/route |
< BillOfMaterialInfo > array |
description |
Description of the segment. |
string |
documentReferences |
List of document references for operation/route level |
< DocumentInfo > array |
equipmentIds |
List of equipments. It is required to have equipments for each operation, but not route segment |
< integer (int64) > array |
id |
id of the route segment |
integer (int64) |
name |
Name of the segment. |
string |
properties |
List of properties for an operation/route |
< PropertiesDefInfo > array |
segmentType |
Type of the segment. Possible options are Segment, Reference |
string |
3.63. SegmentsDefinitionInfo
Segment data tranfer object
Name | Description | Schema |
---|---|---|
schemaVersion |
Version of the segment. |
integer (int32) |
segments |
Details of operations except sequence number |
< SegmentInfo > array |
structure |
Structure represents all the operations and its sequence |
|
structureType |
Structure Type of segment. Possible options are Simple, TreeHierarchy |
string |
3.64. SplitChildDispositionInfoExtend
Name | Schema |
---|---|
bomItem |
< BomItem > array |
dispositionAction |
|
dispositionPlan |
|
dispositionTypeId |
integer (int64) |
futureOrReworkOperations |
< OperationInfo > array |
splitLotChildLotEntry |
3.65. SplitLotChildLotEntry
Split lot child lot information - used by the split lot command to identify details of a child lot to create.
Name | Description | Schema |
---|---|---|
completedQuantities |
Completed quantities for in-progress operations on the child lot |
< SplitLotCompletedQuantityEntry > array |
lotIdentifier |
Lot identifier for the child lot |
string |
plannedQuantity |
Planned quantity for the child lot |
integer (int32) |
3.66. SplitLotCompletedQuantityEntry
Split lot completed quantity information - used by the split lot command to identify completed quantity on an in progress operations for a child lot
Name | Description | Schema |
---|---|---|
completedQuantity |
Completed quantity for the in-progress operation |
integer (int32) |
segmentId |
Segment ID for the in-progress operation |
integer (int64) |
3.67. SplitLotEntry
Split lot information - used by the split lot command to identify a material lot to split and details of the child lots to create.
Name | Description | Schema |
---|---|---|
childMaterialLots |
Child material lot details |
< SplitLotChildLotEntry > array |
materialLotActualId |
ID of the material lot actual to be split |
integer (int64) |
newLotIdentifier |
Optional new lot identifier name for the material lot being split. This allows using the existing lot identifier for one of the child lots. Set to null to keep existing lot identifier on the parent. |
string |
3.68. StructureInfo
Name | Description | Schema |
---|---|---|
operations |
List of operations and its sequence |
< OperationsInfo > array |
routeSegment |
Route segment Information |
3.69. TemplateVariable
Name | Schema |
---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.71. UpdateReceivingInspectionDisposition
Name | Schema |
---|---|
defectSerialNoInfo |
|
dispositionPlanId |
integer (int64) |
insertInfo |
< RISplitChildDispositionInfoExtend > array |
newLotIdentifier |
string |
totalQuantity |
integer (int32) |
updateInfo |
< RISplitChildDispositionInfoExtend > array |
3.72. UriTemplate
Name | Schema |
---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
3.73. WorkOrderInfo
fields should be valid
Name | Description | Schema |
---|---|---|
affectedQuantity |
Minimum value : |
number (double) |
bomItem |
< BomItem > array |
|
lotIdentifier |
string |
|
materialLotActualId |
integer (int64) |
|
operationName |
string |
|
producedMaterialId |
integer (int64) |
|
segmentActualId |
integer (int64) |
|
segmentId |
integer (int64) |
|
serialized |
boolean |
|
splitLotEntrys |
< SplitLotEntry > array |
|
startedOnUnitId |
integer (int64) |
|
workOrderId |
integer (int64) |
|
workOrderName |
string |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : http://localhost/uaa/oauth/authorize
Token URL : http://localhost/uaa/oauth/token
Name | Description |
---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : http://localhost/uaa/oauth/token
Name | Description |
---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : http://localhost/uaa/oauth/authorize
Name | Description |
---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : http://localhost/uaa/oauth/token
Name | Description |
---|---|
default |
Default oauth2 scope. |