1. Overview

1.1. URI scheme

Host : localhost:37250
BasePath : /ncm-app-service/

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-controller : Disposition Controller

  • disposition-plan-controller : Disposition Plan Controller

  • disposition-type-controller : Disposition Type Controller

  • history-controller : History 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

  • user-settings-controller : User Settings Controller

2. Resources

2.1. Context-type-controller

Context Type Controller

2.1.1. getContextType

GET /contexttype
Parameters
Type Name Description Schema Default

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

PagedResources«Resource«ContextTypeInfo»»

201

Success

No Content

401

ERR401: Unauthorized

No Content

404

ERRUD404: Not found

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2. Defect-controller

Defect Controller

2.2.1. createDefects

POST /v2/defect-viewer/createDefects
Parameters
Type Name Description Schema

Body

defect
optional

Defect details to create.

DefectDTO
Responses
HTTP Code Description Schema

201

Success

object

400

ERRCD400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCD404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.2. getDefectQueueSearch

GET /v2/defect-viewer/getDefectQueueSearch
Parameters
Type Name Description Schema Default

Query

defectStatus
optional

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.
Default for product is: Submitted and Active e.i. open defects

< string > array(multi)

Query

page
optional

integer (int32)

0

Query

searchQueue
optional

Search text to find defects
Supported fields are: Product Code, Work Order, Material Lot, NC Name, Disposition Plan Name,

string

Query

size
optional

integer (int32)

20
Responses
HTTP Code Description Schema

200

successful

object

401

ERR401 Unauthorized

No Content

404

ERRDQS404: Not found

No Content

500

ERR500: Internal Server Error

No Content

503

ERR503: Services not found

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.3. getDefects

GET /v2/defect-viewer/getDefects
Parameters
Type Name Description Schema Default

Query

affectedQuantity
optional

Number of Affected_quantity for the defect.

< number (double) > array(multi)

Query

id
optional

ID for the Defect as a filter.

< integer (int64) > array(multi)

Query

lastModifiedBy
optional

User that last modified the Defect.

< string > array(multi)

Query

lastModifiedOn
optional

Date that the Defect was last modified.

< string > array(multi)

Query

likeOnColumn
optional

On column which like operator is affected.

string

Query

likeSearchValue
optional

On column which like search is applied.

string

Query

nonConformanceId
optional

Id of the NonConformance resource.

< integer (int64) > array(multi)

Query

operation
optional

List of Operation as a filter.

< string > array(multi)

Query

orderBy
optional

enum (asc, desc)

"desc"

Query

orderByColumn
optional

Name of the column to sort based on like lastModifiedOn.

string

"lastModifiedOn"

Query

page
optional

integer (int32)

0

Query

serialNumber
optional

SerialNumber (e.g. Lot identifier) as a filter.

< string > array(multi)

Query

size
optional

integer (int32)

20

Query

status
optional

Status of the Defect as a filter. Multiple values are supported
and the results contain all operations matching any of the values.
Available values : Closed, Active, Planned,Not a defect, Submitted

< string > array(multi)

Query

summary
optional

Summary of the Defect as a filter.

< string > array(multi)

Query

workOrder
optional

List of work order Info as a filter.

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.4. getDefectsObject

GET /v2/defect-viewer/getDefectsObject/{objectId}
Parameters
Type Name Description Schema Default

Path

objectId
required

Object id must be a Work Order Id, Material Lot Actual Id, Segment Actaul Id or Production Event Id

integer (int64)

Query

object
required

object

enum (MaterialLotActual, WorkOrder, SegmentActual, RI_ProdEventId)

"MaterialLotActual"

Query

page
optional

integer (int32)

0

Query

size
optional

integer (int32)

20
Responses
HTTP Code Description Schema

200

successful

PagedResources«Resource«DefectViewInfo»»

401

Unauthorized

No Content

412

Precondition fail

No Content

500

Internal server error

No Content

503

Service unavailable

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.5. getOperationsBySearch

GET /v2/defect-viewer/getOperationsBySearch
Parameters
Type Name Description Schema

Query

clockedOnOperator
optional

Currently clocked on operator as a filter.

string

Query

completedAfter
optional

Filter results to return operations completed on or after this time. Combines with CompletedBefore to define a time range.

string (date-time)

Query

completedBefore
optional

Filter results to return operations completed on or before this time. Combines with CompletedAfter to define a time range.

string (date-time)

Query

lotIdentifier
optional

Lot identifier (e.g. Serial Number) as a filter.

string

Query

materialLotActualId
optional

ID of the material lot actual as a filter.

integer (int64)

Query

onHold
optional

Whether the operation is currently on hold as a filter.
If set to true, query will only return operations with active hold records.

boolean

Query

operationName
optional

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
optional

Name of the operation property to sort the results by.

string

Query

page
optional

Page number to return 0 to N.

integer (int32)

Query

plannedOrStartedOnUnitId
optional

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
optional

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
optional

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
optional

ID for the production line as a filter.

< integer (int64) > array(multi)

Query

segmentActualId
optional

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
optional

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
optional

Number of resources to return per page.

integer (int32)

Query

startedOnUnitId
optional

ID for the unit that the segment is executing on as a filter.

integer (int64)

Query

status
optional

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
optional

ID for the work order as a filter.

integer (int64)

Query

workOrderName
optional

Name of the work order as a filter.

string

Query

workOrderPriority
optional

Relative priority of the work order as a filter.

integer (int32)
Responses
HTTP Code Description Schema

200

Success

object

401

ERR401 Unauthorized

No Content

403

ERR403 Forbidden

No Content

404

ERROPBS404 Not Found

No Content

412

ERR412 Precondition Failed

No Content

500

ERROPBS500: Internal Server Error

No Content

503

ERROPBS503 Service unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.6. updateDefect

PUT /v2/defect-viewer/updateDefects/nonconformance/{nonconformanceId}/defect/{defectId}
Parameters
Type Name Description Schema

Path

defectId
required

ID of the Defect to update.

integer (int64)

Path

nonconformanceId
required

Id of the Nonconformance resource to update.

integer (int64)

Body

requestBody
optional

Defect Details to update.

DefectExtend
Responses
HTTP Code Description Schema

200

OK

object

201

Success

No Content

400

ERRUD400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRUD404: Not found

No Content

412

ERRUD412: Defect has been updated since the GET on which the submitted changes were made. Response contains the current record.

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.7. Create defect on receiving inspection

POST /v2/defect-viewer/{contextid}/createdefects
Parameters
Type Name Description Schema

Path

contextid
required

context id for receiving inspection

integer (int64)

Body

defect
optional

Required information to create defects

DefectDTO
Responses
HTTP Code Description Schema

201

Success

object

400

ERRCD400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCD404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.8. getDispositionActions

GET /v2/defect-viewer/{defectId}/dispositionActions
Parameters
Type Name Description Schema

Path

defectId
required

ID for the dispositionAction as a filter.

integer (int64)

Query

nonConformanceId
required

Id of the Nonconformance resource to filter.

integer (int64)
Responses
HTTP Code Description Schema

200

successful

object

400

ERRDA400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRDA404: Not found

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.9. getMateriallotactualsObject

GET /v2/defect-viewer/{workOrderId}/materiallotactuals
Parameters
Type Name Description Schema

Path

workOrderId
required

Id of the work order resource

integer (int64)

Query

parentMaterialLotActualId
optional

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
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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
required

defectId

integer (int64)

Query

page
optional

Number of resources to return per page.

integer (int32)

0

Query

size
optional

Page number to return 0 to N.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4. Defect-type-controller

Defect Type Controller

2.4.1. getDefectTypes

GET /v1/defect-types-viewer
Parameters
Type Name Description Schema Default

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.2. getDefectType

GET /v1/defect-types-viewer/{id}
Parameters
Type Name Description Schema

Query

id
optional

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5. Disposition-controller

Disposition Controller

2.5.1. createDisposition

POST /v2/disposition/createDisposition
Parameters
Type Name Description Schema

Query

dispositionPlanId
optional

ID for the dispositionPlanId as a filter.

integer (int64)

Body

disposition
optional

Disposition details to create.

DispositionViewInfoExtend
Responses
HTTP Code Description Schema

200

OK

object

400

ERRCL400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCL404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.2. createDispositionNonSerialized

POST /v2/disposition/createDispositionNonSerialized
Parameters
Type Name Description Schema

Body

nonSerializedDispositionInfoExtend
optional

Split and DispositionAction details to split the lots and create dispositionAction on them.

< NonSerializedDispositionViewInfoExtend > array
Responses
HTTP Code Description Schema

200

OK

object

400

ERRCL400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCL404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.3. createEmptyDispositionActions

POST /v2/disposition/createEmptyDispositionActions
Parameters
Type Name Description Schema

Body

dispositionPlanDefectIdDtoExtend
optional

DispositionPlan details to create.

DispositionPlanDefectIdDtoExtend
Responses
HTTP Code Description Schema

200

OK

object

400

ERRCL400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCL404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.4. editCTP

PUT /v2/disposition/editCTP
Parameters
Type Name Description Schema

Query

dispositionPlanId
optional

ID for the dispositionPlanId as a filter.

integer (int64)

Body

disposition
optional

Disposition details for CTP to update.

DispositionViewInfoExtend
Responses
HTTP Code Description Schema

200

OK

object

400

ERRCL400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCL404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.5. updateDisposition

PUT /v2/disposition/updateDisposition
Parameters
Type Name Description Schema

Query

dispositionPlanId
optional

ID for the dispositionPlanId for Update.

integer (int64)

Query

previousDisposition
optional

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
optional

Disposition details to update.

DispositionViewInfoExtend
Responses
HTTP Code Description Schema

200

OK

object

400

ERRCL400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCL404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.6. validateForDisposition

POST /v2/disposition/validatefordisposition
Parameters
Type Name Description Schema

Query

dispositionPlanId
optional

ID for the dispositionPlanId as a filter.

integer (int64)

Body

defectSerialNoInfo
optional

to validate the List of DefectSerialNoInfo.

< DefectSerialNoInfo > array
Responses
HTTP Code Description Schema

200

Validation Success

< string, string > map

401

Unauthorized

No Content

404

Work order id or operation not found

No Content

422

Validation Fail

No Content

500

Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.7. createDispositionForRecevingInsepectionApp

POST /v2/disposition/{contextid}/createDisposition
Parameters
Type Name Description Schema

Path

contextid
required

context id for receving inspection

integer (int64)

Body

nonSerializedDispositionInfoExtend
optional

Disposition details to create.

< RINonSerializedDispositionInfoViewExtend > array
Responses
HTTP Code Description Schema

200

OK

object

400

ERRCL400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCL404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.8. getDispositionActionByDefectId

GET /v2/disposition/{nonconformanceId}/{defectId}
Parameters
Type Name Description Schema

Path

defectId
required

ID of the Defect as a filter.

integer (int64)

Path

nonconformanceId
required

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
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6. Disposition-plan-controller

Disposition Plan Controller

2.6.1. createDispositionPlan

POST /v2/dispositionplans
Parameters
Type Name Description Schema

Body

record
optional

Disposition details to create.

DispositionPlanExtend
Responses
HTTP Code Description Schema

201

Created

Resource«DispositionPlanViewInfo»

400

Invalid data supplied: must not set dispositionPlanId property

No Content

401

Unauthorized

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6.2. getAllDispositionPlans

GET /v2/dispositionplans
Parameters
Type Name Description Schema Default

Query

dispositionActionStatus
required

DispositionActionStatus of the operation as a filter,different values are supported like ALL,Open

enum (Open, All)

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7. Disposition-type-controller

Disposition Type Controller

2.7.1. getDispositionTypes

GET /v1/disposition-type-viewer
Parameters
Type Name Description Schema Default

Query

contextid
optional

Context Id for Disposition Type

integer (int64)

1

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.2. getOperations

GET /v1/disposition-type-viewer/getOperations
Parameters
Type Name Description Schema

Query

workOrderId
optional

List of all Operations for the specific workOrder Id.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8. History-controller

History Controller

2.8.1. Get defect history based on Defect ID

GET /v2/history/defecthistory/{id}
Parameters
Type Name Description Schema Default

Path

id
required

ID for the Defect as a filter.

integer (int64)

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

400

defect history not found

No Content

401

Unauthorized

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8.2. Get disposition action history based on Non-Conformance ID

GET /v2/history/dispositionactionhistory/{id}
Parameters
Type Name Description Schema Default

Path

id
required

id must be a Non-Conformance ID

integer (int64)

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

PagedResources«Resource«DispositionActionHistoryViewInfo»»

400

dispostionAction history not found

No Content

401

Unauthorized

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.9. Ncm-patch-controller

NCM Patch Controller

2.9.1. modifyDispositionPlan

PATCH /ncmpatch/modifydispositionplan
Parameters
Type Name Description Schema

Body

disposition
optional

Details on the DispositionPlan to Update.

< DispositionPatch > array
Responses
HTTP Code Description Schema

200

ERR200: Success

object

204

ERR204: No Content

No Content

401

ERR401: Unauthorized

No Content

404

ERR404: disposition action not found

No Content

500

ERR500: Internal server error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10. Non-conformance-controller

Non Conformance Controller

2.10.1. getNonConformances

GET /v1/nonconformance-viewer/getNonConformances
Parameters
Type Name Schema Default

Query

page
optional

integer (int32)

0

Query

size
optional

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

< Resource«NonConformanceViewInfo» > array

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

PagedResources«Resource«NonConformanceTypeViewInfo»»

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.12. Reason-tree-nodes-controller

Reason Tree Nodes Controller

2.12.1. reasonTreeConfiguration

GET /v1/treenodes-viewer
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.12.2. getReasonTreeNodes

GET /v1/treenodes-viewer/{id}
Parameters
Type Name Description Schema

Path

id
optional

Id of the ReasonTreeNodes resource.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13. User-settings-controller

User Settings Controller

2.13.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Body

userSettingsRequest
optional

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResource

204

No Content, Error retrieving created user settings

HttpErrorResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

App ID not found in privilege set

HttpErrorResponse

409

Conflict, User Setting already exists. Use a PUT to update

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Body

request
optional

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, There is no saved User settings for the logged in user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

object

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, User Setting not found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.5. Get Privilege Sets

GET /v2/settings/apps
Parameters
Type Name Description Schema

Query

appName
optional

appName

string
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. BomItem

Name Schema

bomItemId
optional

integer (int64)

bomReallocationQuantity
optional

< integer (int64) > array

3.2. ContextType

Name Description Schema

createdBy
optional

string

createdOn
optional

string (date-time)

deleted
optional

Example : false

boolean

displayName
optional

string

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

version
optional

integer (int32)

3.3. ContextTypeInfo

Name Description Schema

contextTypeId
optional

integer (int64)

createdBy
optional

string

createdOn
optional

string (date-time)

displayName
optional

string

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

requiresReview
optional

Example : false

boolean

version
optional

integer (int32)

3.4. DefectDTO

Name Schema

affectedObjectType
optional

string

defectContextType
optional

string

defectReasonLevel1Id
optional

string

defectReasonLevel2Id
optional

string

defectReasonLevel3Id
optional

string

defectReasonLevel4Id
optional

string

defectTypeId
optional

integer (int64)

description
optional

string

locationType
optional

string

ncmTypeId
optional

integer (int64)

summary
optional

string

workOrder
optional

< WorkOrderInfo > array

3.5. DefectExtend

Name Schema

affectedObjectId
optional

string

affectedQuantity
optional

number (double)

affectedQuantityUnitOfMeasure
optional

string

commentId
optional

string

createdBy
optional
read-only

string

createdOn
optional
read-only

string (date-time)

defectId
optional
read-only

integer (int64)

defectReasonLevel1Id
optional

string

defectReasonLevel2Id
optional

string

defectReasonLevel3Id
optional

string

defectReasonLevel4Id
optional

string

defectTypeId
optional

integer (int64)

description
optional

string

lastModifiedBy
optional
read-only

string

lastModifiedOn
optional
read-only

string (date-time)

locationId
optional

string

locationType
optional

string

nonconformanceId
optional
read-only

integer (int64)

propertyValues
optional

< PropertyValueExtend > array

reportedBy
optional

string

status
optional

string

summary
optional

string

version
optional
read-only

integer (int32)

3.6. DefectNCMIdDto

Name Schema

defectId
optional

integer (int64)

nonConformanceId
optional

integer (int64)

3.7. DefectSerialNoInfo

Name Schema

currentoperationId
optional

integer (int64)

defectId
optional

integer (int64)

dispositionActionId
optional

integer (int64)

dispositionTypeId
optional

integer (int64)

materialLotActualId
optional

integer (int64)

nonConformanceId
optional

integer (int64)

operationId
optional

integer (int64)

segmentActualId
optional

integer (int64)

serialNumber
optional

string

workOrderId
optional

integer (int64)

3.8. DefectViewInfo

Name Schema

affectedObjectId
optional

string

affectedQuantity
optional

number (double)

affectedQuantityUnitOfMeasure
optional

string

appliedSearchOn
optional

string

commentId
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

defectCauseTreeId
optional

string

defectContextType
optional

string

defectId
optional

integer (int64)

defectReasonLevel1Id
optional

string

defectReasonLevel1Name
optional

string

defectReasonLevel2Id
optional

string

defectReasonLevel2Name
optional

string

defectReasonLevel3Id
optional

string

defectReasonLevel3Name
optional

string

defectReasonLevel4Id
optional

string

defectReasonLevel4Name
optional

string

defectTypeId
optional

integer (int64)

defectTypeName
optional

string

description
optional

string

dispositionActionTreeId
optional

string

dispositionActions
optional

< DispositionActionViewInfo > array

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

locationId
optional

string

locationName
optional

string

locationType
optional

string

materialLotActualId
optional

integer (int64)

materialLotActualStatus
optional

string

ncLastModifiedBy
optional

string

ncLastModifiedOn
optional

string (date-time)

nonConformanceType
optional

string

nonconformanceDescription
optional

string

nonconformanceId
optional

integer (int64)

nonconformanceName
optional

string

nonconformanceTypeId
optional

integer (int64)

operation
optional

string

operationId
optional

integer (int64)

product
optional

Product

productFamily
optional

ProductFamily

propertyValues
optional

< PropertyValueInfo > array

receiverId
optional

integer (int64)

receiverNumber
optional

string

reportedBy
optional

string

serialNumber
optional

string

status
optional

string

summary
optional

string

version
optional

integer (int32)

workOrder
optional

string

workOrderId
optional

integer (int64)

3.9. DispositionActionExtend

Name Schema

actionNote
optional

string

commentId
optional

string

createdBy
optional
read-only

string

createdOn
optional
read-only

string (date-time)

daReasonLevel1Id
optional

string

daReasonLevel2Id
optional

string

daReasonLevel3Id
optional

string

daReasonLevel4Id
optional

string

dispositionActionId
optional
read-only

integer (int64)

dispositionPlanId
optional
read-only

integer (int64)

dispositionType
optional

string

elapsedTime
optional

integer (int32)

lastModifiedBy
optional
read-only

string

lastModifiedOn
optional
read-only

string (date-time)

name
optional

string

properties
optional

< PropertyValueExtend > array

quantity
optional

number (double)

status
optional

string

version
optional
read-only

integer (int32)

3.10. DispositionActionHistoryViewInfo

Name Schema

actionNote
optional

string

commentId
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

daReasonLevel1Id
optional

string

daReasonLevel1Name
optional

string

daReasonLevel2Id
optional

string

daReasonLevel2Name
optional

string

daReasonLevel3Id
optional

string

daReasonLevel3Name
optional

string

daReasonLevel4Id
optional

string

daReasonLevel4Name
optional

string

defectId
optional

integer (int64)

dispositionActionHistoryId
optional

integer (int64)

dispositionActionId
optional

integer (int64)

dispositionActionPropertyValues
optional

< PropertyValueInfo > array

dispositionPlan
optional

DispositionPlanInfo

dispositionPlanId
optional

integer (int64)

dispositionType
optional

DispositionTypeInfo

dispositionTypeId
optional

integer (int64)

elapsedTime
optional

integer (int32)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

lastModifiedOperation
optional

string

materialLotActualId
optional

integer (int64)

materialLotActualStatus
optional

string

modifiedOn
optional

string (date-time)

name
optional

string

operation
optional

string

operationId
optional

integer (int64)

product
optional

Product

productFamily
optional

ProductFamily

quantity
optional

number (double)

serialNumber
optional

string

status
optional

string

version
optional

integer (int32)

workOrder
optional

string

workOrderId
optional

integer (int64)

3.11. DispositionActionViewInfo

Name Schema

actionNote
optional

string

commentId
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

daReasonLevel1Id
optional

string

daReasonLevel1Name
optional

string

daReasonLevel2Id
optional

string

daReasonLevel2Name
optional

string

daReasonLevel3Id
optional

string

daReasonLevel3Name
optional

string

daReasonLevel4Id
optional

string

daReasonLevel4Name
optional

string

dispositionActionId
optional

integer (int64)

dispositionPlan
optional

DispositionPlanViewInfo

dispositionType
optional

string

dispositionTypeId
optional

integer (int64)

dispositionTypeNameGlobal
optional

string

elapsedTime
optional

integer (int32)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

lastModifiedOperation
optional

string

materialLotActualId
optional

integer (int64)

materialLotActualStatus
optional

string

name
optional

string

operation
optional

string

operationId
optional

integer (int64)

product
optional

Product

productFamily
optional

ProductFamily

properties
optional

< PropertyValueInfo > array

quantity
optional

number (double)

segmentActualId
optional

integer (int64)

serialNumber
optional

string

status
optional

string

version
optional

integer (int32)

workOrder
optional

string

workOrderId
optional

integer (int64)

3.12. DispositionPatch

Name Schema

defectId
optional

integer (int64)

dispositionActionId
optional

integer (int64)

dispositionPlanId
optional

integer (int64)

nonconformanceId
optional

integer (int64)

3.13. DispositionPlanDefectIdDtoExtend

Name Schema

defectNCMIds
optional

< DefectNCMIdDto > array

dispositionPlanBody
optional

DispositionPlanExtend

3.14. DispositionPlanExtend

Name Schema

createdBy
optional
read-only

string

createdOn
optional
read-only

string (date-time)

dispositionPlanId
optional
read-only

integer (int64)

lastModifiedBy
optional
read-only

string

lastModifiedOn
optional
read-only

string (date-time)

name
optional

string

requiresReview
optional

boolean

reviewed
optional

boolean

reviewedBy
optional

string

reviewedOn
optional

string (date-time)

source
optional

string

version
optional
read-only

integer (int32)

3.15. DispositionPlanInfo

Name Description Schema

createdBy
optional

string

createdOn
optional

string (date-time)

dispositionPlanId
optional

integer (int64)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

requiresReview
optional

Example : false

boolean

reviewed
optional

Example : false

boolean

reviewedBy
optional

string

reviewedOn
optional

string (date-time)

source
optional

string

status
optional

string

version
optional

integer (int32)

3.16. DispositionPlanViewInfo

Name Description Schema

createdBy
optional

string

createdOn
optional

string (date-time)

dispositionPlanId
optional

integer (int64)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

requiresReview
optional

Example : false

boolean

reviewed
optional

Example : false

boolean

reviewedBy
optional

string

reviewedOn
optional

string (date-time)

source
optional

string

version
optional

integer (int32)

3.17. DispositionTypeInfo

Name Description Schema

contextType
optional

< ContextType > array

createdBy
optional

string

createdOn
optional

string (date-time)

dispositionTypeId
optional

integer (int64)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

nameGlobal
optional

string

requiresReview
optional

Example : false

boolean

version
optional

integer (int32)

3.18. DispositionViewInfoExtend

Name Schema

defectSerialNoInfo
optional

< DefectSerialNoInfo > array

dispositionAction
optional

DispositionActionExtend

dispositionPlan
optional

DispositionPlanExtend

futureOrReworkOperations
optional

< OperationInfo > array

3.19. Error

Name Schema

code
optional

string

details
optional

object

3.20. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.21. Link

Name Description Schema

href
optional

string

rel
optional

string

templated
optional

Example : false

boolean

3.22. NonConformanceTypeViewInfo

Name Description Schema

deleted
optional

Example : false

boolean

description
optional

string

id
optional

integer (int64)

nonConformanceType
optional

string

nonConformanceTypeId
optional

integer (int64)

3.23. NonConformanceViewInfo

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

defectInfo
optional

< DefectViewInfo > array

description
optional

string

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

nonConformanceId
optional

integer (int64)

nonConformanceType
optional

string

nonConformanceTypeId
optional

string

source
optional

string

status
optional

string

version
optional

integer (int32)

3.24. NonSerializedDispositionViewInfoExtend

Name Schema

defectSerialNoInfo
optional

DefectSerialNoInfo

dispositionPlanId
optional

integer (int64)

newLotIdentifier
optional

string

splitChildDispositionInfo
optional

< SplitChildDispositionViewInfoExtend > array

totalQuantity
optional

integer (int32)

3.25. OperationInfo

Name Schema

operationId
optional

integer (int64)

operationName
optional

string

3.26. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.27. PagedResources«Resource«ContextTypeInfo»»

Name Schema

content
optional

< Resource«ContextTypeInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.28. PagedResources«Resource«DefectViewInfo»»

Name Schema

content
optional

< Resource«DefectViewInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.29. PagedResources«Resource«DispositionActionHistoryViewInfo»»

Name Schema

content
optional

< Resource«DispositionActionHistoryViewInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.30. PagedResources«Resource«NonConformanceTypeViewInfo»»

Name Schema

content
optional

< Resource«NonConformanceTypeViewInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.31. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.32. Product

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

id
optional

The unique ID of the product

integer (int64)

isSerialized
optional

The product Id is serialized or not
Example : false

boolean

links
optional

< Link > array

productFamilyId
optional

The id of the product family this product is a member of

integer (int64)

3.33. ProductFamily

Name Description Schema

description
optional

The product family’s description

string

id
optional

The unique Id of the product family

integer (int64)

links
optional

< Link > array

3.34. PropertyValueExtend

Name Schema

createdBy
optional
read-only

string

createdOn
optional
read-only

string (date-time)

lastModifiedBy
optional
read-only

string

lastModifiedOn
optional
read-only

string (date-time)

originId
optional
read-only

integer (int64)

propertyDefinitionId
optional

string

propertyValueId
optional
read-only

integer (int64)

value
optional

string

version
optional
read-only

integer (int32)

3.35. PropertyValueInfo

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

dispositionActionHistoryId
optional

integer (int64)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

originId
optional

integer (int64)

propertyDefinitionId
optional

string

propertyValueId
optional

integer (int64)

value
optional

string

version
optional

integer (int32)

3.36. RINonSerializedDispositionInfoViewExtend

Name Schema

defectSerialNoInfo
optional

DefectSerialNoInfo

dispositionPlanId
optional

integer (int64)

newLotIdentifier
optional

string

riSplitChildDispositionInfoExtend
optional

< RISplitChildDispositionInfoViewExtend > array

totalQuantity
optional

integer (int32)

3.37. RISplitChildDispositionInfoViewExtend

Name Schema

dispositionAction
optional

DispositionActionExtend

dispositionPlan
optional

DispositionPlanExtend

dispositionTypeId
optional

integer (int64)

3.38. Resource«ContextTypeInfo»

Name Description Schema

contextTypeId
optional

integer (int64)

createdBy
optional

string

createdOn
optional

string (date-time)

displayName
optional

string

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

links
optional

< Link > array

name
optional

string

requiresReview
optional

Example : false

boolean

version
optional

integer (int32)

3.39. Resource«DefectViewInfo»

Name Schema

affectedObjectId
optional

string

affectedQuantity
optional

number (double)

affectedQuantityUnitOfMeasure
optional

string

appliedSearchOn
optional

string

commentId
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

defectCauseTreeId
optional

string

defectContextType
optional

string

defectId
optional

integer (int64)

defectReasonLevel1Id
optional

string

defectReasonLevel1Name
optional

string

defectReasonLevel2Id
optional

string

defectReasonLevel2Name
optional

string

defectReasonLevel3Id
optional

string

defectReasonLevel3Name
optional

string

defectReasonLevel4Id
optional

string

defectReasonLevel4Name
optional

string

defectTypeId
optional

integer (int64)

defectTypeName
optional

string

description
optional

string

dispositionActionTreeId
optional

string

dispositionActions
optional

< DispositionActionViewInfo > array

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

links
optional

< Link > array

locationId
optional

string

locationName
optional

string

locationType
optional

string

materialLotActualId
optional

integer (int64)

materialLotActualStatus
optional

string

ncLastModifiedBy
optional

string

ncLastModifiedOn
optional

string (date-time)

nonConformanceType
optional

string

nonconformanceDescription
optional

string

nonconformanceId
optional

integer (int64)

nonconformanceName
optional

string

nonconformanceTypeId
optional

integer (int64)

operation
optional

string

operationId
optional

integer (int64)

product
optional

Product

productFamily
optional

ProductFamily

propertyValues
optional

< PropertyValueInfo > array

receiverId
optional

integer (int64)

receiverNumber
optional

string

reportedBy
optional

string

serialNumber
optional

string

status
optional

string

summary
optional

string

version
optional

integer (int32)

workOrder
optional

string

workOrderId
optional

integer (int64)

3.40. Resource«DispositionActionHistoryViewInfo»

Name Schema

actionNote
optional

string

commentId
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

daReasonLevel1Id
optional

string

daReasonLevel1Name
optional

string

daReasonLevel2Id
optional

string

daReasonLevel2Name
optional

string

daReasonLevel3Id
optional

string

daReasonLevel3Name
optional

string

daReasonLevel4Id
optional

string

daReasonLevel4Name
optional

string

defectId
optional

integer (int64)

dispositionActionHistoryId
optional

integer (int64)

dispositionActionId
optional

integer (int64)

dispositionActionPropertyValues
optional

< PropertyValueInfo > array

dispositionPlan
optional

DispositionPlanInfo

dispositionPlanId
optional

integer (int64)

dispositionType
optional

DispositionTypeInfo

dispositionTypeId
optional

integer (int64)

elapsedTime
optional

integer (int32)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

lastModifiedOperation
optional

string

links
optional

< Link > array

materialLotActualId
optional

integer (int64)

materialLotActualStatus
optional

string

modifiedOn
optional

string (date-time)

name
optional

string

operation
optional

string

operationId
optional

integer (int64)

product
optional

Product

productFamily
optional

ProductFamily

quantity
optional

number (double)

serialNumber
optional

string

status
optional

string

version
optional

integer (int32)

workOrder
optional

string

workOrderId
optional

integer (int64)

3.41. Resource«DispositionPlanViewInfo»

Name Description Schema

createdBy
optional

string

createdOn
optional

string (date-time)

dispositionPlanId
optional

integer (int64)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

links
optional

< Link > array

name
optional

string

requiresReview
optional

Example : false

boolean

reviewed
optional

Example : false

boolean

reviewedBy
optional

string

reviewedOn
optional

string (date-time)

source
optional

string

version
optional

integer (int32)

3.42. Resource«NonConformanceTypeViewInfo»

Name Description Schema

deleted
optional

Example : false

boolean

description
optional

string

id
optional

integer (int64)

links
optional

< Link > array

nonConformanceType
optional

string

nonConformanceTypeId
optional

integer (int64)

3.43. Resource«NonConformanceViewInfo»

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

defectInfo
optional

< DefectViewInfo > array

description
optional

string

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

links
optional

< Link > array

name
optional

string

nonConformanceId
optional

integer (int64)

nonConformanceType
optional

string

nonConformanceTypeId
optional

string

source
optional

string

status
optional

string

version
optional

integer (int32)

3.44. SplitChildDispositionViewInfoExtend

Name Schema

dispositionAction
optional

DispositionActionExtend

dispositionPlan
optional

DispositionPlanExtend

dispositionTypeId
optional

integer (int64)

futureOrReworkOperations
optional

< OperationInfo > array

splitLotChildLotEntry
optional

SplitLotChildLotEntry

3.45. 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
required

Completed quantities for in-progress operations on the child lot

< SplitLotCompletedQuantityEntry > array

lotIdentifier
required

Lot identifier for the child lot

string

plannedQuantity
required

Planned quantity for the child lot

integer (int32)

3.46. 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
required

Completed quantity for the in-progress operation

integer (int32)

segmentId
required

Segment ID for the in-progress operation

integer (int64)

3.47. 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
required

Child material lot details

< SplitLotChildLotEntry > array

materialLotActualId
required

ID of the material lot actual to be split

integer (int64)

newLotIdentifier
optional

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.48. UserSettingRequest

Name Description Schema

appId
optional

integer (int32)

data
optional

The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} }
Example : {
"AppKey1" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey2" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey3" : {
"property1" : { },
"property2" : { },
"property3" : { }
}
}

object

viewName
optional

string

3.49. UserSettingResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

3.50. WorkOrderInfo

fields should be valid

Name Description Schema

affectedQuantity
optional

number (double)

bomItem
optional

< BomItem > array

lotIdentifier
optional

string

materialLotActualId
optional

integer (int64)

operationName
optional

string

producedMaterialId
optional

integer (int64)

segmentActualId
optional

integer (int64)

segmentId
optional

integer (int64)

serialized
optional

Example : false

boolean

splitLotEntrys
optional

< SplitLotEntry > array

startedOnUnitId
optional

integer (int64)

workOrderId
optional

integer (int64)

workOrderName
optional

string

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : http://localhost:8443/uaa/oauth/authorize
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : http://localhost:8443/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.