1. Overview
It is an orchestration service for non-conformances during production.
1.2. Tags
-
change-specification-controller : Change Specification Controller
-
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
-
material-lot-controller : Material Lot Controller
-
ncm-patch-controller : NCM Patch Controller
-
non-conformance-controller : Non Conformance Controller
-
non-conformance-type-controller : Non Conformance Type Controller
-
product-controller : Product Controller
-
reason-tree-nodes-controller : Reason Tree Nodes Controller
-
variable-specification-controller : Variable Specification Controller
-
work-order-controller : Work Order Controller
-
workflow-execution-controller : Workflow Execution Controller
2. Resources
2.1. Change-specification-controller
Change Specification Controller
2.1.1. Create a change specification
POST /change-specification
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
changeSpecificationInfo |
ChangeSpecification details to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.2. Get all change specification names
GET /change-specification/changeSpecificationNames
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.3. Get a change specification by id
GET /change-specification/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
id |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.4. Update a change specification
PUT /change-specification/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
id |
integer (int64) |
Body |
changeSpecificationInfo |
ChangeSpecification details to update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.2. Context-type-controller
Context Type Controller
2.2.1. Get context type page resource
GET /contexttype
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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.3. Defect-controller
Defect Controller
2.3.1. Create defect on discreate execution
POST /v2/defect-viewer/createDefects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.3.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 |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
assigneeUserName |
Search Defect with Assignee User Name |
string |
|
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, Pending Disposition Default for product is: Submitted, Pending Disposition 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.3.3. getDefects
GET /v2/defect-viewer/getDefects
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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, Pending Disposition, 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.3.4. getDefectsObject
GET /v2/defect-viewer/getDefectsObject/{objectId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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, WorkOrderSourceLot, InventoryLot) |
|
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.3.5. getOperationsBySearch
GET /v2/defect-viewer/getOperationsBySearch
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.3.6. updateDefect
PUT /v2/defect-viewer/updateDefects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.3.7. Create defect for a given context id
POST /v2/defect-viewer/{contextid}/createdefects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
contextid |
context id for a given flow |
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.3.8. getDispositionActions
GET /v2/defect-viewer/{defectId}/dispositionActions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.3.9. getMateriallotactualsObject
GET /v2/defect-viewer/{workOrderId}/materiallotactuals
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.4. Defect-history-controller
Defect History Controller
2.4.1. getDefectHistory
GET /v1/defect-history/{defectId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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.5. Defect-type-controller
Defect Type Controller
2.5.1. getDefectTypes
GET /v1/defect-types-viewer
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
pageNo |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.5.2. getDefectTypesWithNCTypeId
GET /v1/defect-types-viewer/defectTypes/{nonconformanceTypeId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
nonconformanceTypeId |
ID for the NonConformanceType. |
integer (int64) |
2.5.3. getDefectType
GET /v1/defect-types-viewer/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID for the DefectType. |
integer (int64) |
2.6. Disposition-action-history-controller
Disposition Action History Controller
2.6.1. getDispositionActionHistory
GET /v2/dispositionActionHistory-viewer/getDispositionActionHistory/{nonConformanceId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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.7. Disposition-controller
Disposition Controller
2.7.1. Cancel all unfinished operations on an active rework plan.
PUT /v2/disposition/cancelActiveRework
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
dispositionPlanId |
dispositionPlanId |
integer (int64) |
Body |
dispositionInfo |
DispositionAction Details information to Update dispositionAction. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
object |
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
422 |
Unprocessable entity |
No Content |
500 |
Internal server error |
No Content |
2.7.2. createDisposition
POST /v2/disposition/createDisposition
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
dispositionPlanId |
Id of the dispositionPlan resource. |
integer (int64) |
Body |
disposition |
DispositionAction Details information to create dispositionAction. |
2.7.3. Create disposition for discrete execution
POST /v2/disposition/createDispositions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
dispositionInfo |
Split and DispositionAction details to split the lots and create dispositionAction on them. |
2.7.4. Create Empty Disposition Actions
POST /v2/disposition/createEmptyDispositionActions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
dispositionPlanDefectIdDto |
DispositionAction Details to create empty dispositionAction. |
2.7.5. Update CTP for Discrete Execution
PUT /v2/disposition/editCTP
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.7.6. Update Disposition for Discrete Execution
PUT /v2/disposition/updateDisposition
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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 |
Query |
previousDispositionStatus |
previousDispositionStatus |
string |
Body |
disposition |
DispositionAction Details information to Update dispositionAction. |
2.7.7. Update disposition for receiving inspection
PUT /v2/disposition/updateReceivingInspectionDispositionAction
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
previousDisposition |
previousDisposition |
string |
Query |
previousDispositionStatus |
previousDispositionStatus |
string |
Body |
updateReceivingInspectionInfoList |
DispositionAction Details information to update dispositionAction for Receiving Inspection App |
< UpdateReceivingInspectionDisposition > 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.7.8. Check disposition is possible in same plan or not for Discrete Execution
POST /v2/disposition/validatefordisposition
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.7.9. Update disposition for a given context id. Currently its supporting discrete return flow.
PUT /v2/disposition/{contextId}/update-disposition
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
contextId |
Context id for a flow. |
integer (int32) |
Query |
previousDisposition |
previousDisposition |
string |
Query |
previousDispositionStatus |
previousDispositionStatus |
string |
Body |
updateReceivingInspectionInfoList |
DispositionAction Details information to update dispositionAction for Receiving Inspection App |
< UpdateReceivingInspectionDisposition > 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.7.10. Create disposition for a context id. Currently RI and discrete return flow is supported.
POST /v2/disposition/{contextid}/createDisposition
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
contextid |
Context id for a flow. |
integer (int64) |
Body |
nonSerializedDispositionInfoExtend |
DispositionAction Details information to create dispositionAction for the given context id |
< 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.7.11. getDispositionActionByDefectId
GET /v2/disposition/{nonconformanceId}/{defectId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.8. Disposition-plan-controller
Disposition Plan Controller
2.8.1. createDispositionPlan
POST /v2/dispositionplans
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.8.2. getAllDispositionPlans
GET /v2/dispositionplans
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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.9. Disposition-type-controller
Disposition Type Controller
2.9.1. getDispositionTypes
GET /v1/disposition-type-viewer
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
ncTypeId |
Non-conformance type Id |
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.9.2. getWorkOrderSegments
GET /v1/disposition-type-viewer/getOperations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
workOrderId |
List of all Operations for the specific workOrder Id. |
integer (int64) |
2.10. Material-lot-controller
Material Lot Controller
2.10.1. Get list of materialLots
GET /materialLots
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
lotIdentifier |
lot identifier (use lot_identifier/event_num for this property) |
string |
Query |
productId |
Product ID (applied product id) to retrieve materialLots. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialLotInfo > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.11. Ncm-patch-controller
NCM Patch Controller
2.11.1. modifyDispositionPlan
PATCH /ncmpatch/modifydispositionplan
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.12. Non-conformance-controller
Non Conformance Controller
2.12.1. createNonConfromance
POST /v1/nonconformance-viewer
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.12.2. getNonConformances
GET /v1/nonconformance-viewer/getNonConformances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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.13. Non-conformance-type-controller
Non Conformance Type Controller
2.13.1. getNonConformanceTypes
GET /v1/nonconformance-types-viewer
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
contextType |
Context Type |
string |
|
Query |
deleted |
NCType of the operation as a filter, different values are supported like All,false,true |
enum (true, false) |
|
Query |
paze |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.14. Product-controller
Product Controller
2.14.1. Get Products
GET /products
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
isSerialized |
isSerialized |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ProductResponseInfo > array |
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
404 |
Not Found |
2.15. Reason-tree-nodes-controller
Reason Tree Nodes Controller
2.15.1. reasonTreeConfiguration
GET /v1/treenodes-viewer
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
2.15.2. getReasonTreeNodes
GET /v1/treenodes-viewer/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of the ReasonTreeNodes resource. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ReasonTreeNodeDto > array |
401 |
Unauthorized |
No Content |
2.16. Variable-specification-controller
Variable Specification Controller
2.16.1. getDefectVariableSpecitionDetails
GET /v2/defect-varables
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
defectIds |
defectIds |
< integer (int64) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< VariableDetailsWithSpecs > array |
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
2.17. Work-order-controller
Work Order Controller
2.17.1. Get Workorders
GET /workorders
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
routeId |
routeId |
integer (int64) |
Query |
status |
status |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
404 |
Not Found |
2.18. Workflow-execution-controller
Workflow Execution Controller
2.18.1. Get workflow execution level groups
GET /workflow-execution/level-groups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
disposititionType |
disposititionType |
string |
Query |
planId |
planId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ExecutionDetails > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.18.2. Get workflow execution
GET /workflow-execution/level-groups-execution
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
disposititionType |
disposititionType |
string |
Query |
planId |
planId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.18.3. Get workflow executions
GET /workflow-execution/level-groups-executions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
executionId |
executionId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.18.4. Get workflow status
GET /workflow-execution/workflow-status
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
dispositionType |
dispositionType |
string |
Query |
planId |
planId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< WorkflowStatusInfo > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
3. Definitions
3.1. AppliesTo
| Name | Schema |
|---|---|
excludedMaterialLotActualIds |
< integer (int64) > array |
materialLotActualIds |
< integer (int64) > array |
3.2. ApprovalProcessRequest
Approval process request associated with submit disposition
| Name | Description | Schema |
|---|---|---|
changeSpecificationInfo |
||
workFlowId |
Approval process workflow id. |
integer (int64) |
3.3. AssociatedProduct
| Name | Schema |
|---|---|
associationId |
integer (int64) |
productId |
integer (int64) |
unitId |
integer (int64) |
3.4. Attachments
| Name | Description | Schema |
|---|---|---|
attachmentName |
document name |
string |
attachmentType |
attachment type |
string |
documentId |
documentId of the document |
string |
3.5. BomFormulation
| Name | Schema |
|---|---|
associatedProducts |
< object > array |
behaviors |
< object > array |
crossReferences |
< object > array |
effectiveDate |
object |
expirationDate |
object |
formulationCode |
string |
formulationDescription |
string |
formulationItems |
< FormulationItem > array |
producedQuantity |
number (double) |
producedQuantityPrecision |
integer (int32) |
producedQuantityUnitOfMeasureId |
object |
propertyValues |
< object > array |
schemaVersion |
integer (int32) |
3.6. BomItem
| Name | Schema |
|---|---|
bomItemId |
integer (int64) |
bomReallocationQuantity |
< integer (int64) > array |
3.7. ChangeSpecificationInfo
| Name | Schema |
|---|---|
bomFormulation |
|
bomFormulationId |
integer (int64) |
producedMaterialId |
integer (int64) |
schemaVersion |
integer (int32) |
segments |
< SegmentInfo > array |
specificationId |
integer (int64) |
specificationName |
string |
structure |
|
structureType |
enum (tree, simple) |
toolState |
3.8. ClockOnRecordViewer
| Name | Schema |
|---|---|
clockOffTime |
string (date-time) |
clockOnTime |
string (date-time) |
clockedOn |
boolean |
id |
integer (int64) |
loggedInUser |
boolean |
operator |
string |
3.9. ContextType
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
displayName |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
version |
integer (int32) |
3.10. ContextTypePage
| Name | Schema |
|---|---|
content |
< ContextTypeResource > array |
links |
< Link > array |
page |
3.11. ContextTypeResource
| Name | 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 |
boolean |
version |
integer (int32) |
3.12. CrossReference
| Name | Schema |
|---|---|
externalId |
string |
externalSystemId |
integer (int64) |
3.13. DefectAssigneeInfo
| Name | Description | Schema |
|---|---|---|
assigneeGroupId |
Assignee Group Id |
string |
assigneeUserName |
Assignee User Name |
string |
3.14. DefectDTO
| Name | Schema |
|---|---|
affectedObjectType |
string |
assignees |
< DefectAssigneeInfo > array |
attachments |
< Attachments > array |
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.15. 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.16. DefectInfoExtend
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
assignees |
< DefectAssigneeInfo > array |
attachments |
< Attachments > array |
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) |
nonconformanceTypeId |
integer (int64) |
propertyValues |
< PropertyValueExtend > array |
reportedBy |
string |
status |
string |
summary |
string |
version |
integer (int32) |
3.17. DefectNCMIdDto
| Name | Schema |
|---|---|
defectId |
integer (int64) |
nonConformanceId |
integer (int64) |
3.18. 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.19. DefectTypeInfo
| 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) |
parentId |
integer (int64) |
propertyValues |
< DefectTypePropertyValueInfo > array |
version |
integer (int32) |
3.20. DefectTypePropertyValueInfo
| Name | Schema |
|---|---|
propertyDefinitionId |
string |
value |
string |
3.21. 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) |
propertyValues |
< DefectTypePropertyValueInfo > array |
version |
integer (int32) |
3.22. DefectTypesWithNCTypeViewInfo
| Name | Schema |
|---|---|
defectTypes |
< DefectTypeInfo > array |
3.23. DefectViewInfo
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
appliedSearchOn |
string |
assignees |
< DefectAssigneeInfo > array |
attachments |
< Attachments > array |
commentId |
string |
contextType |
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.24. 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.25. DispositionActionInfoExtend
| Name | Schema |
|---|---|
actionNote |
string |
attachments |
< Attachments > array |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel2Id |
string |
daReasonLevel3Id |
string |
daReasonLevel4Id |
string |
dispositionActionId |
integer (int64) |
dispositionPlanId |
integer (int64) |
dispositionType |
string |
dispositionTypeNameGlobal |
string |
elapsedTime |
integer (int32) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
properties |
< PropertyValueExtend > array |
quantity |
number (double) |
status |
string |
version |
integer (int32) |
3.26. DispositionActionResource
| Name | Schema |
|---|---|
actionNote |
string |
attachments |
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.27. DispositionActionViewInfo
| Name | Schema |
|---|---|
actionNote |
string |
attachments |
< Attachments > array |
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 |
materialChangeViewInfo |
|
materialLotActualId |
integer (int64) |
materialLotActualStatus |
string |
materialLotParentIds |
< integer (int64) > array |
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.28. DispositionInfo
| Name | Schema |
|---|---|
nonSerializedDispositionInfoExtend |
< NonSerializedDispositionInfoExtend > array |
segmentsDefinition |
3.29. DispositionInfoExtend
| Name | Schema |
|---|---|
approvalProcessRequest |
|
defectSerialNoInfo |
< DefectSerialNoInfo > array |
dispositionAction |
|
dispositionPlan |
|
futureOrReworkOperations |
< OperationInfo > array |
segmentsDefinition |
3.30. DispositionPatch
| Name | Schema |
|---|---|
defectId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionPlanId |
integer (int64) |
nonconformanceId |
integer (int64) |
3.31. DispositionPlanDefectIdDto
| Name | Schema |
|---|---|
defectNCMIds |
< DefectNCMIdDto > array |
dispositionPlanBody |
3.32. DispositionPlanInfo
| Name | 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 |
boolean |
reviewed |
boolean |
reviewedBy |
string |
reviewedOn |
string (date-time) |
source |
string |
status |
string |
version |
integer (int32) |
3.33. 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.34. 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.35. DispositionTypeInfo
| Name | Schema |
|---|---|
contextType |
< ContextType > array |
createdBy |
string |
createdOn |
string (date-time) |
dispositionBehaviorTypeId |
integer (int64) |
dispositionCode |
string |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
nameGlobal |
string |
parentId |
integer (int64) |
propertyValues |
< DispositionTypePropertyValueInfo > array |
requiresReview |
boolean |
version |
integer (int32) |
3.36. DispositionTypePropertyValueInfo
| Name | Schema |
|---|---|
propertyDefinitionId |
string |
value |
string |
3.37. DispositionTypeViewInfo
| Name | Schema |
|---|---|
dispositionCode |
string |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
name |
string |
nameGlobal |
string |
propertyValues |
< DispositionTypePropertyValueInfo > array |
requiresReview |
boolean |
workflowConfigs |
< WorkflowConfigurationInfo > array |
3.39. 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.40. 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 |
propertyValues |
< DefectTypePropertyValueInfo > array |
version |
integer (int32) |
3.41. EntityModel«DefectTypesWithNCTypeViewInfo»
| Name | Schema |
|---|---|
defectTypes |
< DefectTypeInfo > array |
links |
< Link > array |
3.42. EntityModel«DefectViewInfo»
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
appliedSearchOn |
string |
assignees |
< DefectAssigneeInfo > array |
attachments |
< Attachments > array |
commentId |
string |
contextType |
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.43. 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.44. 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.45. EntityModel«DispositionTypeViewInfo»
| Name | Schema |
|---|---|
dispositionCode |
string |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
links |
< Link > array |
name |
string |
nameGlobal |
string |
propertyValues |
< DispositionTypePropertyValueInfo > array |
requiresReview |
boolean |
workflowConfigs |
< WorkflowConfigurationInfo > array |
3.46. EntityModel«NonConformanceTypeViewInfo»
| Name | Schema |
|---|---|
deleted |
boolean |
description |
string |
displayName |
string |
id |
integer (int64) |
links |
< Link > array |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
propertyValues |
< PropertyValues > array |
3.47. 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.48. 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.50. ExecutionDetails
| Name | Schema |
|---|---|
groupinfo |
< GroupStatusInfo > array |
levelId |
integer (int32) |
levelName |
string |
3.51. FailedVariableInfo
| Name | Schema |
|---|---|
lowerReject |
string |
sample |
string |
target |
string |
testValue |
string |
upperReject |
string |
variableId |
integer (int64) |
variableName |
string |
3.52. FormulationItem
| Name | Schema |
|---|---|
appliesTo |
|
behaviors |
< string > array |
displayOrder |
integer (int32) |
itemId |
integer (int32) |
itemReference |
string |
locationId |
integer (int32) |
lotDescription |
object |
lowerTolerance |
object |
lowerTolerancePrecision |
integer (int32) |
productId |
integer (int32) |
propertyValues |
< object > array |
quantity |
number (double) |
quantityPrecision |
integer (int32) |
scrapFactor |
number (double) |
substitutions |
object |
unitId |
object |
unitOfMeasureId |
integer (int32) |
upperTolerance |
object |
upperTolerancePrecision |
integer (int32) |
3.53. FormulationItemsConsumption
| Name | Schema |
|---|---|
behaviors |
< string > array |
itemReference |
string |
lowerTolerance |
number (double) |
quantity |
number (double) |
quantityPrecision |
integer (int32) |
upperTolerance |
number (double) |
3.54. GroupStatusInfo
| Name | Schema |
|---|---|
groupName |
string |
groupType |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
recievedReverification |
boolean |
status |
string |
3.56. LaborPlan
| Name | Schema |
|---|---|
laborCodes |
< integer (int64) > array |
standardLaborPlan |
< LaborPlanItem > array |
3.57. LaborPlanItem
| Name | Schema |
|---|---|
basis |
enum (item, lot) |
laborPlanningTypeId |
integer (int64) |
time |
integer (int64) |
3.58. 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.59. MaterialChangeViewInfo
| Name | Schema |
|---|---|
productName |
string |
routeName |
string |
workOrderName |
string |
3.60. MaterialLotInfo
| Name | Schema |
|---|---|
currentQuantity |
number (float) |
extendedInfo |
string |
id |
integer (int64) |
initialQuantity |
number (double) |
isSerialized |
boolean |
location |
string |
lotIdentifier |
string |
processOrderId |
integer (int64) |
productCode |
string |
productDesc |
string |
productFamilyDesc |
string |
productId |
integer (int64) |
sourceDetailsInfo |
|
status |
string |
statusId |
integer (int64) |
unitId |
integer (int64) |
3.61. MaterialLotSourceDetailsInfo
| Name | Description | Schema |
|---|---|---|
id |
Source Id |
integer (int64) |
name |
Source name |
string |
source |
Source |
string |
status |
Source Status |
string |
3.62. 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.63. NonConformanceTypeViewInfo
| Name | Schema |
|---|---|
deleted |
boolean |
description |
string |
displayName |
string |
id |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
propertyValues |
< PropertyValues > array |
3.64. 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.65. NonSerializedDispositionInfoExtend
| Name | Schema |
|---|---|
defectSerialNoInfo |
|
dispositionPlanId |
integer (int64) |
newLotIdentifier |
string |
splitChildDispositionInfo |
< SplitChildDispositionInfoExtend > array |
totalQuantity |
integer (int32) |
3.67. 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.68. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.69. PagedModel«EntityModel«DefectHistoryViewInfo»»
| Name | Schema |
|---|---|
content |
< EntityModel«DefectHistoryViewInfo» > array |
links |
< Link > array |
page |
3.70. PagedModel«EntityModel«DefectTypeViewInfo»»
| Name | Schema |
|---|---|
content |
< EntityModel«DefectTypeViewInfo» > array |
links |
< Link > array |
page |
3.71. PagedModel«EntityModel«DefectViewInfo»»
| Name | Schema |
|---|---|
content |
< EntityModel«DefectViewInfo» > array |
links |
< Link > array |
page |
3.72. PagedModel«EntityModel«DispositionActionHistoryViewInfo»»
| Name | Schema |
|---|---|
content |
|
links |
< Link > array |
page |
3.73. PagedModel«EntityModel«DispositionPlanViewInfo»»
| Name | Schema |
|---|---|
content |
< EntityModel«DispositionPlanViewInfo» > array |
links |
< Link > array |
page |
3.74. PagedModel«EntityModel«DispositionTypeViewInfo»»
| Name | Schema |
|---|---|
content |
< EntityModel«DispositionTypeViewInfo» > array |
links |
< Link > array |
page |
3.75. PagedModel«EntityModel«NonConformanceTypeViewInfo»»
| Name | Schema |
|---|---|
content |
< EntityModel«NonConformanceTypeViewInfo» > array |
links |
< Link > array |
page |
3.76. PagedModel«EntityModel«OperationViewer»»
| Name | Schema |
|---|---|
content |
< EntityModel«OperationViewer» > array |
links |
< Link > array |
page |
3.77. PlannedUnit
| Name | Schema |
|---|---|
machinePlan |
|
peoplePlan |
|
unitId |
integer (int32) |
3.78. 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 |
externalRevision |
The external revision |
integer (int64) |
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.79. 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.80. ProductResponseInfo
| Name | Schema |
|---|---|
code |
string |
description |
string |
id |
integer (int64) |
3.81. 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.82. 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) |
rowMappingIndex |
string |
value |
string |
version |
integer (int32) |
3.84. RINonSerializedDispositionInfoExtend
| Name | Schema |
|---|---|
defectSerialNoInfo |
|
dispositionPlanId |
integer (int64) |
newLotIdentifier |
string |
riSplitChildDispositionInfoExtend |
< RISplitChildDispositionInfoExtend > array |
totalQuantity |
number (double) |
3.85. RISplitChildDispositionInfoExtend
| Name | Description | Schema |
|---|---|---|
approvalProcessRequest |
Approval workflow request of the disposition. Send only if approval is required for disposition |
|
dispositionAction |
||
dispositionPlan |
||
dispositionTypeId |
integer (int64) |
3.86. 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 |
commentRequired |
flag to check if reason is mendatory |
boolean |
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.87. Segment
| Name | Schema |
|---|---|
appliesTo |
|
behaviors |
< string > array |
dataEntryPlans |
< object > array |
description |
string |
documents |
< Document > array |
formulationItemsConsumption |
< FormulationItemsConsumption > array |
name |
string |
plannedUnits |
< PlannedUnit > array |
propertyValues |
< PropertyValues > array |
segmentId |
integer (int64) |
segmentType |
enum (group, route, segment) |
suggestedLaborTypes |
< integer (int32) > array |
toolCategoryIds |
< integer (int64) > array |
toolIds |
< integer (int64) > array |
3.88. SegmentInfo
| Name | Schema |
|---|---|
allVariables |
< object > array |
allbomItems |
< object > array |
appliesTo |
|
behaviors |
< string > array |
dataEntryPlans |
< integer (int64) > array |
description |
string |
documents |
< Document > array |
formulationItemsConsumption |
< FormulationItemsConsumption > array |
name |
string |
plannedUnits |
< PlannedUnit > array |
propertyDefinationData |
< object > array |
propertyValues |
< PropertyValues > array |
savedDocs |
< object > array |
segmentId |
integer (int64) |
segmentType |
enum (group, route, segment) |
suggestedLaborTypes |
< integer (int64) > array |
toolCategoryIds |
< integer (int64) > array |
toolIds |
< integer (int64) > array |
3.89. SegmentsDefinitions
| Name | Schema |
|---|---|
bomFormulation |
|
bomFormulationId |
object |
plannedLineId |
integer (int32) |
producedMaterialId |
integer (int32) |
schemaVersion |
integer (int32) |
segments |
< Segment > array |
structure |
|
structureType |
string |
3.90. SequenceElement
| Name | Schema |
|---|---|
children |
< SequenceElement > array |
displayOrder |
integer (int64) |
mutualExclusionSets |
< integer (int64) > array |
segmentId |
integer (int64) |
sequenceNumber |
integer (int64) |
skipIfSuccessorStarted |
boolean |
3.91. SplitChildDispositionInfoExtend
| Name | Description | Schema |
|---|---|---|
approvalProcessRequest |
Approval workflow request of the disposition. Send only if approval is required for disposition |
|
bomItem |
< BomItem > array |
|
dispositionAction |
||
dispositionPlan |
||
dispositionTypeId |
integer (int64) |
|
dispositionTypeNameGlobal |
string |
|
futureOrReworkOperations |
< OperationInfo > array |
|
splitLotChildLotEntry |
3.92. 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.93. 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.94. 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.96. Substitution
| Name | Schema |
|---|---|
conversionFactor |
number (double) |
productId |
integer (int64) |
quantity |
number (double) |
quantityPrecision |
integer (int32) |
substitutionOrder |
integer (int32) |
uom |
integer (int64) |
3.97. TemplateVariable
| Name | Schema |
|---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.99. ToolState
| Name | Schema |
|---|---|
currentOperationId |
integer (int64) |
operationToolMapping |
< object > array |
operations |
< object > array |
tools |
< object > array |
3.100. UpdateReceivingInspectionDisposition
| Name | Schema |
|---|---|
defectSerialNoInfo |
|
dispositionPlanId |
integer (int64) |
insertInfo |
< RISplitChildDispositionInfoExtend > array |
newLotIdentifier |
string |
totalQuantity |
integer (int32) |
updateInfo |
< RISplitChildDispositionInfoExtend > array |
3.101. UriTemplate
| Name | Schema |
|---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
3.102. VariableDetailsWithSpecs
| Name | Schema |
|---|---|
activityId |
integer (int64) |
actualValue |
number (float) |
keyId1 |
integer (int64) |
lotIdentifier |
string |
lowerRejectValue |
number (float) |
segmentActualId |
integer (int64) |
targetValue |
number (float) |
upperRejectValue |
number (float) |
varId |
integer (int64) |
variableName |
string |
3.103. WorkOrderInfo
fields should be valid
| Name | Description | Schema |
|---|---|---|
affectedQuantity |
Minimum value : |
number (double) |
bomItem |
< BomItem > array |
|
failedVariable |
< FailedVariableInfo > 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 |
3.104. WorkflowConfigurationInfo
| Name | Schema |
|---|---|
active |
boolean |
coOwner |
string |
createdBy |
string |
createdOn |
string (date-time) |
equipementId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lineId |
integer (int64) |
name |
string |
revision |
integer (int32) |
workflowEventName |
string |
3.105. WorkflowExecutionsPage
| Name | Schema |
|---|---|
content |
< WorkflowLevelGroupExecutionInfo > array |
links |
< Link > array |
page |
3.106. WorkflowLevelGroupExecutionInfo
| Name | Schema |
|---|---|
activityId |
integer (int64) |
groupName |
string |
groupType |
string |
id |
integer (int64) |
levelGroupCreatedOn |
string (date-time) |
levelId |
integer (int32) |
levelName |
string |
monitorGroupId |
integer (int64) |
monitorSecurityGroup |
string |
recievedReverification |
boolean |
requestId |
string |
requestName |
string |
revision |
integer (int32) |
status |
string |
workflowExecutionId |
integer (int64) |
workflowLevelGroupExecutionId |
integer (int64) |
workflowName |
string |
workflowStartedBy |
string |
workflowStartedOn |
string (date-time) |
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. |