1. Overview

BFF for non-conformances.

1.1. URI scheme

Host : localhost:35640
BasePath : /swagger-docs/

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

  • defect-variable-specification-controller : Defect Variable Specification Controller

  • disposition-controller : Disposition Controller

  • disposition-plan-controller : Disposition Plan Controller

  • disposition-type-controller : Disposition Type Controller

  • document-controller : Document Controller

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

  • unit-controller : Unit Controller

  • user-settings-controller : User Settings 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
required

Represents the id of the site to connect to

string

Body

changeSpecificationInfo
optional

ChangeSpecification details to create.

ChangeSpecificationInfo
Responses
HTTP Code Description Schema

200

Ok

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.2. Get all change specification names

GET /change-specification/changeSpecificationNames
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

Ok

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.3. Get a change specification by id

GET /change-specification/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

Ok

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.4. Update a change specification

PUT /change-specification/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)

Body

changeSpecificationInfo
optional

ChangeSpecification details to update.

ChangeSpecificationInfo
Responses
HTTP Code Description Schema

200

Ok

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2. Context-type-controller

Context Type Controller

2.2.1. getContextType

GET /contexttype
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

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

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3. Defect-controller

Defect Controller

2.3.1. createDefects

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.2. getDefectQueueSearch

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

assigneeUserName
optional

assigneeUserName

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.3. getDefects

GET /v2/defect-viewer/getDefects
Caution

operation.deprecated
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.4. getDefectsObject

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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, WorkOrderSourceLot)

"MaterialLotActual"

Query

page
optional

integer (int32)

0

Query

size
optional

integer (int32)

20
Responses
HTTP Code Description Schema

200

successful

object

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.5. getOperationsBySearch

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.6. updateDefect

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.7. Create defect on receiving inspection

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.8. getDispositionActions

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.9. getMateriallotactualsObject

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.2. getDefectTypeByNCTypeId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

nonconformanceTypeId
required

nonconformanceTypeId

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.3. getDefectType

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.6. Defect-variable-specification-controller

Defect Variable Specification Controller

2.6.1. getDefectVariableSpecitionDetails

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

defectIds
optional

defectIds

< integer (int64) > array(multi)
Responses
HTTP Code Description Schema

200

OK

object

201

Success

No Content

400

ERRCD400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCD404: Defect Variables not found

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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
required

Represents the id of the site to connect to

string

Query

dispositionPlanId
optional

dispositionPlanId

integer (int64)

Body

dispositionInfo
optional

DispositionAction Details information to Update dispositionAction.

DispositionInfoExtend
Responses
HTTP Code Description Schema

200

OK

object

400

ERRCL400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

422

Unprocessable entity

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.2. createDisposition

POST /v2/disposition/createDisposition
Caution

operation.deprecated
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.3. Create disposition for discrete execution

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

dispositionInfo
optional

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

DispositionInfo
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.4. Create empty disposition for discrete execution

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.5. Edit CTP for discrete execution

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.6. Update disposition for discrete execution

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

Query

previousDispositionStatus
optional

previousDispositionStatus

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.7. Update disposition for receiving inspection

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

previousDisposition
optional

previousDisposition

string

Query

previousDispositionStatus
optional

previousDispositionStatus

string

Body

updateReceivingInspectionDisposition
optional

Disposition details to update.

< UpdateReceivingInspectionDisposition > 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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.8. Validate, we can add 2 or more defect in same plan or not

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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
required

Represents the id of the site to connect to

string

Path

contextId
required

Context id for a given flow

integer (int32)

Query

previousDisposition
optional

previousDisposition

string

Query

previousDispositionStatus
optional

previousDispositionStatus

string

Body

updateReceivingInspectionDisposition
optional

Disposition details to update.

< UpdateReceivingInspectionDisposition > 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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.10. Create disposition for receiving inspection

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

contextid
required

context id for receiving 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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.11. getDispositionActionByDefectId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.8. Disposition-plan-controller

Disposition Plan Controller

2.8.1. createDispositionPlan

POST /v2/dispositionplans
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

record
optional

Disposition details to create.

DispositionPlanExtend
Responses
HTTP Code Description Schema

201

Created

object

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.8.2. getAllDispositionPlans

GET /v2/dispositionplans
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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
required

Represents the id of the site to connect to

string

Query

ncTypeId
optional

NonConformanceType 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

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9.2. getOperations

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10. Document-controller

Document Controller

2.10.1. Create metadata

POST /v1/documents-viewer
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

clientId
required

clientId

string

Body

documentMetaInfo
required

Metadata for creation of document or revision

string
Responses
HTTP Code Description Schema

201

Created

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

ApiError
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.2. Get Documents

GET /v1/documents-viewer
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

clientId
required

clientId

string

Query

docId
optional

document id

string

Query

pageNo
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.3. Document upload

PUT /v1/documents-viewer
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

attachmentName
optional

attachment name

string

Query

clientId
required

clientId

string

Query

docId
required

document id

string

Query

rev
required

_rev

string

FormData

file
required

document to upload

file
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

409

Conflict

ApiError

422

Unprocessable Entity

ApiError
Consumes

  • multipart/form-data

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.4. Get document

GET /v1/documents-viewer/attachment
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

attachmentName
required

attachment name

string

Query

clientId
required

clientId

string

Query

docId
required

document id or url

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11. History-controller

History Controller

2.11.1. Get defect history based on Defect ID

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

object

400

dispostionAction history not found

No Content

401

Unauthorized

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12. Material-lot-controller

Material Lot Controller

2.12.1. Get list of materialLots and their properties

GET /v1/material-lots-viewer
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

lotIdentifier
required

lotIdentifier

string

Query

productId
required

productId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< MaterialLotInfo > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=utf-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13. Ncm-patch-controller

NCM Patch Controller

2.13.1. modifyDispositionPlan

PATCH /ncmpatch/modifydispositionplan
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14. Non-conformance-controller

Non Conformance Controller

2.14.1. getNonConformances

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

page
optional

integer (int32)

0

Query

size
optional

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15. Non-conformance-type-controller

Non Conformance Type Controller

2.15.1. getNonConformanceTypes

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

contextExecutionType
optional

Context Type

string

Query

deleted
optional

NCType of the operation as a filter, different values are supported like All,false,true

enum (true, false)

"false"

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

PagedModel«EntityModel«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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.16. Product-controller

Product Controller

2.16.1. Get Products

GET /products
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

isSerialized
optional

isSerialized

boolean
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.17. Reason-tree-nodes-controller

Reason Tree Nodes Controller

2.17.1. reasonTreeConfiguration

GET /v1/treenodes-viewer
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.17.2. getReasonTreeNodes

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18. Unit-controller

Unit Controller

2.18.1. Get unit details by unit id

GET /v1/units/{unitId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

unitId
required

Id of the requested unit

integer (int64)
Responses
HTTP Code Description Schema

200

OK

Unit

204

No Content

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19. User-settings-controller

User Settings Controller

2.19.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

userSettingsRequest
required

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResponseResource

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

string

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.5. Get Privilege Sets

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20. Work-order-controller

Work Order Controller

2.20.1. Get Workorders

GET /workorders
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

routeId
required

routeId

integer (int64)

Query

status
optional

status

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

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21. Workflow-execution-controller

Workflow Execution Controller

2.21.1. Get workflow execution level groups

GET /v1.0/workflow-execution/level-groups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

disposititionType
required

disposititionType

string

Query

planId
required

planId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ExecutionDetails > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.2. Get workflow execution

GET /v1.0/workflow-execution/level-groups-execution
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

disposititionType
required

disposititionType

string

Query

planId
required

planId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

WorkflowLevelGroupExecutionInfo

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.3. Get workflow executions

GET /v1.0/workflow-execution/level-groups-executions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

executionId
required

executionId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

WorkflowExecutionsPage

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.4. Get workflow status

GET /v1.0/workflow-execution/workflow-status
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

dispositionType
required

dispositionType

string

Query

planId
required

planId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< WorkflowStatusInfo > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

3. Definitions

3.1. ApiError

Http Error response.

Name Schema

errorCode
optional

string

message
optional

string

requestPath
optional

string

status
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

subErrors
optional

ApiSubError

3.2. ApiSubError

Name Schema

errorCode
optional

string

field
optional

string

message
optional

string

value
optional

object

3.3. AppliesTo

Name Schema

excludedMaterialLotActualIds
optional

< integer (int64) > array

materialLotActualIds
optional

< integer (int64) > array

3.4. ApprovalProcessRequest

Approval process request associated with submit disposition

Name Description Schema

changeSpecificationInfo
optional

ChangeSpecificationInfo

workFlowId
optional

Approval process workflow id.

integer (int64)

3.5. Attachments

Name Description Schema

attachmentName
optional

document name

string

attachmentType
optional

attachment type

string

documentId
optional

documentId of the document

string

3.6. BomFormulation

Name Schema

associatedProducts
optional

< object > array

behaviors
optional

< object > array

crossReferences
optional

< object > array

effectiveDate
optional

object

expirationDate
optional

object

formulationCode
optional

string

formulationDescription
optional

string

formulationItems
optional

< FormulationItem > array

producedQuantity
optional

number (double)

producedQuantityPrecision
optional

integer (int32)

producedQuantityUnitOfMeasureId
optional

object

propertyValues
optional

< object > array

schemaVersion
optional

integer (int32)

3.7. BomItem

Name Schema

bomItemId
optional

integer (int64)

bomReallocationQuantity
optional

< integer (int64) > array

3.8. ChangeSpecificationInfo

Name Schema

bomFormulation
optional

BomFormulation

bomFormulationId
optional

integer (int64)

producedMaterialId
optional

integer (int64)

schemaVersion
optional

integer (int32)

segments
optional

< SegmentInfo > array

specificationId
optional

integer (int64)

specificationName
optional

string

structure
optional

Structure

structureType
optional

enum (tree, simple)

toolState
optional

ToolState

3.9. CollectionMetadata

Name Schema

totalElements
optional

integer (int32)

3.10. DefectAssigneeInfo

Name Description Schema

assigneeGroupId
optional

Assignee Group Id

string

assigneeUserName
optional

Assignee User Name

string

3.11. DefectDTO

Name Schema

affectedObjectType
optional

string

assignees
optional

< DefectAssigneeInfo > array

attachments
optional

< Attachments > array

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.12. DefectExtend

Name Schema

affectedObjectId
optional

string

affectedQuantity
optional

number (double)

affectedQuantityUnitOfMeasure
optional

string

assignees
optional

< DefectAssigneeInfo > array

attachments
optional

< Attachments > array

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

ncmTypeId
optional

integer (int64)

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.13. DefectNCMIdDto

Name Schema

defectId
optional

integer (int64)

nonConformanceId
optional

integer (int64)

3.14. 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.15. DispositionActionExtend

Name Schema

actionNote
optional

string

attachments
optional

< Attachments > array

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

dispositionTypeNameGlobal
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.16. DispositionActionInfoExtend

Name Schema

actionNote
optional

string

attachments
optional

< Attachments > array

commentId
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

daReasonLevel1Id
optional

string

daReasonLevel2Id
optional

string

daReasonLevel3Id
optional

string

daReasonLevel4Id
optional

string

dispositionActionId
optional

integer (int64)

dispositionPlanId
optional

integer (int64)

dispositionType
optional

string

dispositionTypeNameGlobal
optional

string

elapsedTime
optional

integer (int32)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

properties
optional

< PropertyValueExtend > array

quantity
optional

number (double)

status
optional

string

version
optional

integer (int32)

3.17. DispositionActionViewInfo

Name Schema

actionNote
optional

string

attachments
optional

< Attachments > array

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

materialChangeViewInfo
optional

MaterialChangeViewInfo

materialLotActualId
optional

integer (int64)

materialLotActualStatus
optional

string

materialLotParentIds
optional

< integer (int64) > array

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.18. DispositionInfo

Name Schema

nonSerializedDispositionInfoExtend
optional

< NonSerializedDispositionInfoExtend > array

segmentsDefinition
optional

SegmentsDefinitions

3.19. DispositionInfoExtend

Name Schema

approvalProcessRequest
optional

ApprovalProcessRequest

defectSerialNoInfo
optional

< DefectSerialNoInfo > array

dispositionAction
optional

DispositionActionInfoExtend

dispositionPlan
optional

DispositionPlanInfoExtend

futureOrReworkOperations
optional

< OperationInfo > array

segmentsDefinition
optional

SegmentsDefinitions

3.20. DispositionPatch

Name Schema

defectId
optional

integer (int64)

dispositionActionId
optional

integer (int64)

dispositionPlanId
optional

integer (int64)

nonconformanceId
optional

integer (int64)

3.21. DispositionPlanDefectIdDtoExtend

Name Schema

defectNCMIds
optional

< DefectNCMIdDto > array

dispositionPlanBody
optional

DispositionPlanExtend

3.22. 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.23. DispositionPlanInfoExtend

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

dispositionPlanId
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

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

integer (int32)

3.24. DispositionPlanViewInfo

Name 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

boolean

reviewed
optional

boolean

reviewedBy
optional

string

reviewedOn
optional

string (date-time)

source
optional

string

version
optional

integer (int32)

3.25. DispositionViewInfoExtend

Name Schema

approvalProcessRequest
optional

ApprovalProcessRequest

defectSerialNoInfo
optional

< DefectSerialNoInfo > array

dispositionAction
optional

DispositionActionExtend

dispositionPlan
optional

DispositionPlanExtend

futureOrReworkOperations
optional

< OperationInfo > array

segmentsDefinition
optional

SegmentsDefinitions

3.26. Document

Name Schema

displayName
optional

string

link
optional

string

3.27. EntityModel«NonConformanceTypeViewInfo»

Name Schema

deleted
optional

boolean

description
optional

string

displayName
optional

string

id
optional

integer (int64)

links
optional

< Link > array

nonConformanceType
optional

string

nonConformanceTypeId
optional

integer (int64)

propertyValues
optional

< PropertyValues > array

3.28. Error

Name Schema

code
optional

string

details
optional

object

3.29. ExecutionDetails

Name Schema

groupinfo
optional

< GroupStatusInfo > array

levelId
optional

integer (int32)

levelName
optional

string

3.30. FailedVariableInfo

Name Schema

lowerReject
optional

string

sample
optional

string

target
optional

string

testValue
optional

string

upperReject
optional

string

variableId
optional

integer (int64)

variableName
optional

string

3.31. FormulationItem

Name Schema

appliesTo
optional

AppliesTo

behaviors
optional

< string > array

displayOrder
optional

integer (int32)

itemId
optional

integer (int32)

itemReference
optional

string

locationId
optional

integer (int32)

lotDescription
optional

object

lowerTolerance
optional

object

lowerTolerancePrecision
optional

integer (int32)

productId
optional

integer (int32)

propertyValues
optional

< object > array

quantity
optional

number (double)

quantityPrecision
optional

integer (int32)

scrapFactor
optional

number (double)

substitutions
optional

object

unitId
optional

object

unitOfMeasureId
optional

integer (int32)

upperTolerance
optional

object

upperTolerancePrecision
optional

integer (int32)

3.32. FormulationItemsConsumption

Name Schema

behaviors
optional

< string > array

itemReference
optional

string

lowerTolerance
optional

number (double)

quantity
optional

number (double)

quantityPrecision
optional

integer (int32)

upperTolerance
optional

number (double)

3.33. GroupStatusInfo

Name Schema

groupName
optional

string

groupType
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

recievedReverification
optional

boolean

status
optional

string

3.34. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.35. LaborPlan

Name Schema

laborCodes
optional

< integer (int64) > array

standardLaborPlan
optional

< LaborPlanItem > array

3.36. LaborPlanItem

Name Schema

basis
optional

enum (item, lot)

laborPlanningTypeId
optional

integer (int64)

time
optional

integer (int64)

3.37. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

name
optional

string

profile
optional

string

rel
optional

string

template
optional

UriTemplate

templated
optional

boolean

title
optional

string

type
optional

string

3.38. MaterialChangeViewInfo

Name Schema

productName
optional

string

routeName
optional

string

workOrderName
optional

string

3.39. MaterialLotInfo

Name Schema

currentQuantity
optional

number (float)

extendedInfo
optional

string

id
optional

integer (int64)

initialQuantity
optional

number (double)

isSerialized
optional

boolean

location
optional

string

lotIdentifier
optional

string

processOrderId
optional

integer (int64)

productCode
optional

string

productDesc
optional

string

productFamilyDesc
optional

string

productId
optional

integer (int64)

sourceDetailsInfo
optional

MaterialLotSourceDetailsInfo

status
optional

string

statusId
optional

integer (int64)

unitId
optional

integer (int64)

3.40. MaterialLotSourceDetailsInfo

Name Description Schema

id
optional

Source Id

integer (int64)

name
optional

Source name

string

source
optional

Source

string

status
optional

Source Status

string

3.41. NonConformanceTypeViewInfo

Name Schema

deleted
optional

boolean

description
optional

string

displayName
optional

string

id
optional

integer (int64)

nonConformanceType
optional

string

nonConformanceTypeId
optional

integer (int64)

propertyValues
optional

< PropertyValues > array

3.42. NonSerializedDispositionInfoExtend

Name Schema

defectSerialNoInfo
optional

DefectSerialNoInfo

dispositionPlanId
optional

integer (int64)

newLotIdentifier
optional

string

splitChildDispositionInfo
optional

< SplitChildDispositionInfoExtend > array

totalQuantity
optional

integer (int32)

3.43. OperationInfo

Name Schema

operationId
optional

integer (int64)

operationName
optional

string

3.44. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.45. PagedModel«EntityModel«NonConformanceTypeViewInfo»»

Name Schema

content
optional

< EntityModel«NonConformanceTypeViewInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.46. PlannedUnit

Name Schema

machinePlan
optional

LaborPlan

peoplePlan
optional

LaborPlan

unitId
optional

integer (int32)

3.47. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.48. Product

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

descriptionGlobal
optional

The description of the product global

string

eventEsignatureLevel
optional

The event Esiganature level

integer (int64)

externalLink
optional

Product External Link

string

externalRevision
optional

The external revision

integer (int64)

id
optional

The unique ID of the product

integer (int64)

isSerialized
optional

The product Id is serialized or not

boolean

links
optional

< Link > array

productChangeEsignatureLevel
optional

The product change Esiganature level

integer (int64)

productFamilyId
optional

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

integer (int64)

productGroupId
optional

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

integer (int64)

3.49. 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.50. PropertyValueExtend

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

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.51. 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)

parentId
optional

integer (int64)

propertyDefinitionId
optional

string

propertyValueId
optional

integer (int64)

rowMappingIndex
optional

string

value
optional

string

version
optional

integer (int32)

3.52. PropertyValues

Name Schema

propertyDefinitionId
optional

string

propertyValue
optional

string

3.53. RINonSerializedDispositionInfoViewExtend

Name Schema

defectSerialNoInfo
optional

DefectSerialNoInfo

dispositionPlanId
optional

integer (int64)

newLotIdentifier
optional

string

riSplitChildDispositionInfoExtend
optional

< RISplitChildDispositionInfoViewExtend > array

totalQuantity
optional

number (double)

3.54. RISplitChildDispositionInfoExtend

Name Description Schema

approvalProcessRequest
optional

Approval workflow request of the disposition. Send only if approval is required for disposition

ApprovalProcessRequest

dispositionAction
optional

DispositionActionInfoExtend

dispositionPlan
optional

DispositionPlanInfoExtend

dispositionTypeId
optional

integer (int64)

3.55. RISplitChildDispositionInfoViewExtend

Name Description Schema

approvalProcessRequest
optional

Approval workflow request of the disposition. Send only if approval is required for disposition

ApprovalProcessRequest

dispositionAction
optional

DispositionActionExtend

dispositionPlan
optional

DispositionPlanExtend

dispositionTypeId
optional

integer (int64)

3.56. Segment

Name Schema

appliesTo
optional

AppliesTo

behaviors
optional

< string > array

dataEntryPlans
optional

< object > array

description
optional

string

documents
optional

< Document > array

formulationItemsConsumption
optional

< FormulationItemsConsumption > array

name
optional

string

plannedUnits
optional

< PlannedUnit > array

propertyValues
optional

< PropertyValues > array

segmentId
optional

integer (int64)

segmentType
optional

enum (group, route, segment)

suggestedLaborTypes
optional

< integer (int32) > array

toolCategoryIds
optional

< integer (int64) > array

toolIds
optional

< integer (int64) > array

3.57. SegmentInfo

Name Schema

allVariables
optional

< object > array

allbomItems
optional

< object > array

appliesTo
optional

AppliesTo

behaviors
optional

< string > array

dataEntryPlans
optional

< integer (int64) > array

description
optional

string

documents
optional

< Document > array

formulationItemsConsumption
optional

< FormulationItemsConsumption > array

name
optional

string

plannedUnits
optional

< PlannedUnit > array

propertyDefinationData
optional

< object > array

propertyValues
optional

< PropertyValues > array

savedDocs
optional

< object > array

segmentId
optional

integer (int64)

segmentType
optional

enum (group, route, segment)

suggestedLaborTypes
optional

< integer (int64) > array

toolCategoryIds
optional

< integer (int64) > array

toolIds
optional

< integer (int64) > array

3.58. SegmentsDefinitions

Name Schema

bomFormulation
optional

BomFormulation

bomFormulationId
optional

object

plannedLineId
optional

integer (int32)

producedMaterialId
optional

integer (int32)

schemaVersion
optional

integer (int32)

segments
optional

< Segment > array

structure
optional

Structure

structureType
optional

string

3.59. SequenceElement

Name Schema

children
optional

< SequenceElement > array

displayOrder
optional

integer (int64)

mutualExclusionSets
optional

< integer (int64) > array

segmentId
optional

integer (int64)

sequenceNumber
optional

integer (int64)

skipIfSuccessorStarted
optional

boolean

3.60. SplitChildDispositionInfoExtend

Name Description Schema

approvalProcessRequest
optional

Approval workflow request of the disposition. Send only if approval is required for disposition

ApprovalProcessRequest

bomItem
optional

< BomItem > array

dispositionAction
optional

DispositionActionInfoExtend

dispositionPlan
optional

DispositionPlanInfoExtend

dispositionTypeId
optional

integer (int64)

dispositionTypeNameGlobal
optional

string

futureOrReworkOperations
optional

< OperationInfo > array

splitLotChildLotEntry
optional

SplitLotChildLotEntry

3.61. 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.62. 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.63. 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.64. Structure

Name Schema

sequence
optional

SequenceElement

3.65. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

enum (, ?, &, /, #, *)

3.66. ToolState

Name Schema

currentOperationId
optional

integer (int64)

operationToolMapping
optional

< object > array

operations
optional

< object > array

tools
optional

< object > array

3.67. Unit

Name Description Schema

assetId
optional

The asset ID

integer (int64)

isInventoryUnit
optional

Is this unit an inventory unit. A inventory unit is a storage unit.

boolean

isVirtual
optional

Is this unit a virtual unit. A virtual unit is a tracking unit. It doesn’t have physical assets associated with it.

boolean

lineId
optional

The line this unit belongs to

integer (int64)

links
optional

< Link > array

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

unitRank
optional

This unit’s rank

integer (int32)

units
optional

Collection of Groups belonging to this Unit

UnitCollection

3.68. UnitCollection

Name Schema

collection
optional

CollectionMetadata

content
optional

< Unit > array

links
optional

< Link > array

3.69. UpdateReceivingInspectionDisposition

Name Schema

defectSerialNoInfo
optional

DefectSerialNoInfo

dispositionPlanId
optional

integer (int64)

insertInfo
optional

< RISplitChildDispositionInfoExtend > array

newLotIdentifier
optional

string

totalQuantity
optional

integer (int32)

updateInfo
optional

< RISplitChildDispositionInfoExtend > array

3.70. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

3.71. 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.72. UserSettingResponseResource

Name Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

boolean

links
optional

< Link > array

viewName
optional

string

3.73. WorkOrderInfo

fields should be valid

Name Schema

affectedQuantity
optional

number (double)

bomItem
optional

< BomItem > array

failedVariable
optional

< FailedVariableInfo > 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

boolean

splitLotEntrys
optional

< SplitLotEntry > array

startedOnUnitId
optional

integer (int64)

workOrderId
optional

integer (int64)

workOrderName
optional

string

3.74. WorkflowExecutionsPage

Name Schema

content
optional

< WorkflowLevelGroupExecutionInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.75. WorkflowLevelGroupExecutionInfo

Name Schema

activityId
optional

integer (int64)

groupName
optional

string

groupType
optional

string

id
optional

integer (int64)

levelGroupCreatedOn
optional

string (date-time)

levelId
optional

integer (int32)

levelName
optional

string

monitorGroupId
optional

integer (int64)

monitorSecurityGroup
optional

string

recievedReverification
optional

boolean

requestId
optional

string

requestName
optional

string

revision
optional

integer (int32)

status
optional

string

workflowExecutionId
optional

integer (int64)

workflowLevelGroupExecutionId
optional

integer (int64)

workflowName
optional

string

workflowStartedBy
optional

string

workflowStartedOn
optional

string (date-time)

3.76. WorkflowStatusInfo

Name Schema

requestId
optional

string

status
optional

string

4. Security

4.1. access_token

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

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.