1. Overview

Documentation for receiving-inspection-app-service API v1.0

1.1. Version information

Version : 1.0

1.2. URI scheme

Host : localhost
BasePath : /

1.3. Tags

  • external-config-controller : External Config Controller

  • material-lot-controller : Material Lot Controller

  • product-controller : Product Controller

  • property-definition-controller : Property Definition Controller

  • receiver-material-lots-controller : Receiver Material Lots Controller

  • sample-material-lot-controller : Sample Material Lot Controller

  • test-material-lot-controller : Test Material Lot Controller

  • units-controller : Units Controller

  • variable-controller : Variable Controller

  • work-order-controller : Work Order Controller

  • workflow-execution-controller : Workflow Execution Controller

1.4. Produces

  • application/json

2. Resources

2.1. External-config-controller

External Config Controller

2.1.1. Get external Configurations

GET /v1.0/external-configuration/configurations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

actionId
optional

actionId

integer (int32)

Query

actionName
optional

actionName

string

Query

actionTypeId
optional

actionTypeId

integer (int32)

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

configId
optional

configId

integer (int64)

Query

credentials
optional

object

Query

details
optional

object

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

principal
optional

object

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

ExternalConfigResponsePage

204

No Content, Error retrieving actions

HttpErrorResponse

400

Bad Request

HttpErrorResponse

401

User Unauthorized

No Content

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.2. Material-lot-controller

Material Lot Controller

2.2.1. Create MaterialLot

POST /v1.0/materialLots/materialLot
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

materialLot
required

materialLot

MaterialLot
Responses
HTTP Code Description Schema

200

OK

string

400

Bad Request

HttpErrorResponseNew

404

Not Found

HttpErrorResponseNew

422

Unprocessable Entity

HttpErrorResponseNew

500

Internal Server Error

HttpErrorResponseNew
Consumes

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.2. Used for bulk updating the disposition info for material lots

POST /v1.0/materialLots/updateLotStatus
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

materialLotUpdateInfo
required

materialLotUpdateInfo

< MaterialLotUpdate > array
Responses
HTTP Code Description Schema

200

OK

object

400

Bad data

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

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.2.3. Validating the MaterialLot Names sent for a given Unit Id

POST /v1.0/materialLots/validate
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

validationRequestInfo
required

validationRequestInfo

ValidationRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Bad data

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

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.2.4. Used for updating the disposition info for a material lot Id

PUT /v1.0/materialLots/{materialLotId}/disposition
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

materialLotId
required

materialLotId

integer (int64)

Body

dispositionInfo
required

dispositionInfo

DispositionInfo
Responses
HTTP Code Description Schema

200

OK

object

201

CREATED

object

400

Bad data

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

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.2.5. Get list of materialLot properties

GET /v1.0/materialLots/{materialLotId}/properties
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

materialLotId
required

materialLotId

integer (int64)

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

credentials
optional

object

Query

details
optional

object

Query

offset
optional

integer (int64)

Query

pageNumber
optional

integer (int32)

Query

pageSize
optional

integer (int32)

Query

paged
optional

boolean

Query

principal
optional

object

Query

sort.sorted
optional

boolean

Query

sort.unsorted
optional

boolean

Query

unpaged
optional

boolean
Responses
HTTP Code Description Schema

200

OK

< MaterialLotPropertyDefinitionInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal server error

No Content

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.3. Product-controller

Product Controller

2.3.1. Get list of material properties

GET /v1.0/product/{productId}/properties
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

productId
required

productId

integer (int64)

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

credentials
optional

object

Query

details
optional

object

Query

principal
optional

object
Responses
HTTP Code Description Schema

200

OK

MaterialLotPropertyResults

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal server error

No Content

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.4. Property-definition-controller

Property Definition Controller

2.4.1. Get All Additional properties

GET /v1.0/additionalProperties
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

< PropertyDefinitionInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

422

Unprocessable Entity

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.5. Receiver-material-lots-controller

Receiver Material Lots Controller

2.5.1. Update multiple MaterialLot records

PUT /v1.0/receiverMaterialLots/materialLots
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

materialLotUpdateInfo
required

materialLotUpdateInfo

< MaterialLotUpdate > array
Responses
HTTP Code Description Schema

200

OK

string

400

Bad Request

HttpErrorResponseNew

404

Not Found

HttpErrorResponseNew

422

Unprocessable Entity

HttpErrorResponseNew

500

Internal Server Error

HttpErrorResponseNew
Consumes

  • 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. Get MaterialLot By materialLotId

GET /v1.0/receiverMaterialLots/materialLots/{materialLotId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

materialLotId
required

materialLotId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ReceiverMaterialLotsDto > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

422

Unprocessable Entity

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.5.3. Get All productionStatus

GET /v1.0/receiverMaterialLots/productionStatus
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

< ProductionStatus > 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.5.4. Get All MaterialLots

GET /v1.0/receiverMaterialLots/receivers
Caution

operation.deprecated
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

searchText
optional

searchText

string

Query

status
optional

status

enum (OPEN, CLOSE)

"Open"
Responses
HTTP Code Description Schema

200

OK

< ReceiverMaterialLots > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

422

Unprocessable Entity

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.5.5. Get Receivers by search

GET /v1.0/receiverMaterialLots/receiversSearch
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

searchText
optional

searchText

string

Query

status
optional

status

enum (OPEN, CLOSE)

"Open"
Responses
HTTP Code Description Schema

200

OK

< ReceiverInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

422

Unprocessable Entity

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.5.6. Get All Sample Tests

GET /v1.0/receiverMaterialLots/tests
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

materialLotId
optional

materialLotId

integer (int64)

Query

receiverId
optional

receiverId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< SampleTestMaterialLots > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

422

Unprocessable Entity

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.5.7. Get All MaterialLots By receiverId

GET /v1.0/receiverMaterialLots/{receiverId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

receiverId
required

receiverId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ReceiverMaterialLotsDto > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

422

Unprocessable Entity

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.5.8. Update MaterialLot records of receivernumber

POST /v1.0/receiverMaterialLots/{receiverId}/assignSerialNumbers
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

receiverId
required

receiverId

integer (int64)

Body

receiverMaterialLotsInfo
required

receiverMaterialLotsInfo

ReceiverMaterialLotsInfo
Responses
HTTP Code Description Schema

200

OK

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)

400

Bad Request

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.9. Update Receiver status

POST /v1.0/receiverMaterialLots/{receiverId}/complete
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

receiverId
required

receiverId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

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)

400

Bad Request

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.10. Generate receiver samples

POST /v1.0/receiverMaterialLots/{receiverId}/generateSamples
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

receiverId
required

receiverId

integer (int64)

Body

generateSamplesInfo
required

generateSamplesInfo

GenerateSamplesInfo
Responses
HTTP Code Description Schema

201

Created

object

400

Invalid data

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.6. Sample-material-lot-controller

Sample Material Lot Controller

2.6.1. Create sample

POST /v1.0/samples
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

credentials
optional

object

Query

details
optional

object

Query

principal
optional

object

Body

sampleMaterialLotId
required

sampleMaterialLotId

SampleMaterialLotId
Responses
HTTP Code Description Schema

201

Created

SampleTestMaterialLotResult

400

Invalid data

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

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.6.2. Update Sample

PUT /v1.0/samples/{sampleId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

sampleId
required

sampleId

integer (int64)

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

credentials
optional

object

Query

details
optional

object

Query

principal
optional

object

Body

sampleUpdateInfo
required

Sample Description

SampleMaterialLotUpdateInfo
Responses
HTTP Code Description Schema

200

OK

SampleMaterialLotResult

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

500

Internal server error

No Content

503

Service Unavailable

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.6.3. Delete Sample

DELETE /v1.0/samples/{sampleId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

sampleId
required

sampleId

integer (int64)

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

credentials
optional

object

Query

details
optional

object

Query

principal
optional

object
Responses
HTTP Code Description Schema

204

No Content

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

500

Internal server error

No Content

503

Service Unavailable

HttpErrorResponse
Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7. Test-material-lot-controller

Test Material Lot Controller

2.7.1. Update test

PUT /v1.0/tests/{testId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

testId
required

testId

integer (int64)

Body

testMaterialLotInfo
required

testMaterialLotInfo

TestMaterialLotInfoRequest
Responses
HTTP Code Description Schema

200

OK

TestMaterialLotResult

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

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.8. Units-controller

Units Controller

2.8.1. Retrieves all the statuses of a given Unit ID

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

unitId
required

unitId

integer (int64)

Query

fromStatusIds
optional

fromStatusIds

string
Responses
HTTP Code Description Schema

200

OK

TransactionStatus

400

Bad data

HttpErrorResponse

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.9. Variable-controller

Variable Controller

2.9.1. getVariableDetailsWithSpecs

GET /v1.0/variable/outOfSpecsVariablesDetails
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

eventIds
optional

List of User Defined Event Ids to get variable details with Specs.

< integer (int64) > array(multi)

Query

recieverId
optional

Reciver Name

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< VariableDetailsWithSpecs > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

UnProcessable Entity

HttpErrorResponse

500

Internal Server error

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.9.2. Get variable specification limit for a particular time

GET /v1.0/variable/variablespecification
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

credentials
optional

object

Query

details
optional

object

Query

principal
optional

object

Query

productId
optional

product id

integer (int64)

Query

startTime
required

time at which you are looking for

string

Query

variableIds
required

List of variables separated by comma(,)

string
Responses
HTTP Code Description Schema

200

OK

TestValueSpecifications

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal server error

No Content

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.10. Work-order-controller

Work Order Controller

2.10.1. Get OSP operation lots of a work order

GET /v1.0/workorders/{workOrderId}/getLots
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

workOrderId
required

ID for the work order as a filter.

integer (int64)

Query

materialLotActualId
optional

ID of the material lot actual as a filter.

integer (int64)

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

segmentActualIds
optional

Comma separated list of segmentActualIds

string

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

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, Skipped, Excluded

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

200

OK

object

401

Unauthorized

HttpErrorResponse

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.11. Workflow-execution-controller

Workflow Execution Controller

2.11.1. Get DIT 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

materialLotId
required

materialLotId

integer (int64)

Query

receiverName
required

receiverName

string

Query

type
required

type

string
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.11.2. 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

materialLotIds
required

materialLotIds

string

Query

receiverName
required

receiverName

string

Query

type
required

type

string
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

3. Definitions

3.1. DefectInfoResponse

Name Schema

affectedObjectId
optional

string

affectedObjectType
optional

string

affectedQuantity
optional

number (double)

affectedQuantityUnitOfMeasure
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

< DispositionActionInfo > array

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

locationId
optional

string

locationType
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)

parentId
optional

integer (int64)

propertyValues
optional

< DefectPropertyValueInfo > array

reportedBy
optional

string

status
optional

string

summary
optional

string

version
optional

integer (int32)

3.2. DefectPropertyValueInfo

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

originId
optional

integer (int64)

propertyDefinitionId
optional

string

propertyValueId
optional

integer (int64)

rowMappingIndex
optional

string

value
optional

string

version
optional

integer (int32)

3.3. DispositionActionInfo

Name Schema

actionNote
optional

string

attachments
optional

string

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)

dispositionPlan
optional

DispositionPlanInfo

dispositionPlanId
optional

integer (int64)

dispositionTypeId
optional

integer (int64)

dispositionTypeName
optional

string

dispositionTypeNameGlobal
optional

string

elapsedTime
optional

integer (int32)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

lastModifiedOperation
optional

string

name
optional

string

parentId
optional

integer (int64)

properties
optional

< PropertyValueInfo > array

quantity
optional

number (double)

status
optional

string

version
optional

integer (int32)

3.4. DispositionInfo

Disposition Info for updating in PA for a material lot

Name Description Schema

propertyValues
optional

Property values for a given material lot

< MaterialProperties > array

statusId
optional

Disposition status for a given material lot

integer (int64)

unitId
optional

Unit Id for which the statuses to be retrieved

integer (int64)

3.5. DispositionPlanInfo

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

parentId
optional

integer (int64)

requiresReview
optional

boolean

reviewed
optional

boolean

reviewedBy
optional

string

reviewedOn
optional

string (date-time)

source
optional

string

status
optional

string

version
optional

integer (int32)

3.6. Error

Name Schema

code
optional

string

details
optional

object

3.7. ExecutionDetails

Name Schema

groupinfo
optional

< GroupStatusInfo > array

levelId
optional

integer (int32)

levelName
optional

string

3.8. ExternalConfigResponse

Name Schema

actionId
optional

integer (int64)

actionName
optional

string

actionType
optional

string

actionTypeId
optional

integer (int64)

configId
optional

integer (int64)

createdBy
optional

string

data
optional

object

deleted
optional

boolean

id
optional

integer (int64)

updatedBy
optional

string

3.9. ExternalConfigResponsePage

Name Schema

content
optional

< ExternalConfigResponse > array

links
optional

Links

page
optional

PageMetadata

3.10. GenerateSamplesInfo

Generate Samples Info

Name Description Schema

productId
required

Product Id

integer (int64)

3.11. GroupStatusInfo

Name Schema

groupName
optional

string

groupType
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

recievedReverification
optional

boolean

status
optional

string

3.12. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.13. HttpErrorResponseNew

Name Schema

error
optional

Error

path
optional

string

timestampVal
optional

string

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

Name Schema

empty
optional

boolean

3.16. MaterialLot

Name Schema

initialQuantity
optional

number (double)

lotIdentifier
optional

string

productId
optional

integer (int64)

properties
optional

< MaterialProperties > array

status
optional

string

3.17. MaterialLotProperties

Name Schema

defaultValue
optional

string

displayName
optional

string

propertyDataTyeId
optional

integer (int64)

propertyDataType
optional

string

propertyDefinitionId
optional

string

propertyName
optional

string

propertyValue
optional

string

required
optional

boolean

3.18. MaterialLotPropertyDefinitionInfo

Name Description Schema

dataType
optional

The datatype of the property

string

defaultValue
optional

string

displayName
optional

string

propertyDefinitionId
required

The id of the property definition

string

propertyDefinitionName
required

The name of the property definition

string

propertyValue
required

The value of the property

string

3.19. MaterialLotPropertyResults

Name Schema

content
optional

< MaterialLotPropertyDefinitionInfo > array

links
optional

Links

page
optional

PageMetadata

3.20. MaterialLotPropertyValues

Name Schema

initialId
optional

string

propertyDefinitionId
optional

string

propertyValue
optional

string

3.21. MaterialLotUpdate

MaterialLotUpdate

Name Description Schema

lotIdentifier
optional

string

lotQuantity
optional

number (double)

materialLotId
optional

integer (int64)

periodicInspectionQty
optional

Periodic Inspection Quantity

number (double)

productId
optional

integer (int64)

propertyValues
optional

< MaterialLotPropertyValues > array

statusId
optional

integer (int64)

unitId
optional

materialot unit Id

integer (int64)

3.22. MaterialLots

Name Schema

commentId
optional

integer (int64)

isSerialized
optional

boolean

lotIdentifier
optional

string

materialLotId
optional

integer (int64)

materialLotStatus
optional

string

materialLotStatusId
optional

integer (int64)

materialLotsEntryOn
optional

string

productCode
optional

string

productDesc
optional

string

productId
optional

integer (int64)

quantity
optional

integer (int64)

unitId
optional

integer (int64)

unitName
optional

string

3.23. MaterialLotsDto

Name Schema

commentId
optional

integer (int64)

defectInfoResponses
optional

< DefectInfoResponse > array

isSerialized
optional

boolean

lineName
optional

string

lotIdentifier
optional

string

materialLotId
optional

integer (int64)

materialLotStatus
optional

string

materialLotStatusId
optional

integer (int64)

materialLotsEntryOn
optional

string

operationName
optional

string

periodicInspectionQty
optional

number (double)

productCode
optional

string

productDesc
optional

string

productId
optional

integer (int64)

propertyValues
optional

< MaterialLotProperties > array

quantity
optional

number (double)

segmentActualId
optional

integer (int64)

segmentId
optional

integer (int64)

unitId
optional

integer (int64)

unitName
optional

string

workOrderId
optional

integer (int64)

3.24. MaterialProperties

Properties of a material.

Name Description Schema

defaultValue
optional

string

displayName
optional

string

propertyDefinitionId
optional

string

propertyName
required

Name of the property

string

propertyValue
required

Value of the property

string

3.25. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.26. ProductionStatus

Name Schema

colorId
optional

integer (int64)

iconId
optional

integer (int64)

id
optional

integer (int64)

lifeCycleStage
optional

integer (int64)

prodStatusDesc
optional

string

prodStatusDescLocal
optional

string

3.27. PropertyDefinitionInfo

Name Schema

defaultValue
optional

string

displayName
optional

string

initialId
optional

string

propertyDataType
optional

string

propertyDataTypeId
optional

integer (int32)

propertyDefinitionId
optional

string

propertyName
optional

string

required
optional

boolean

3.28. 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.29. ReceiverInfo

Name Schema

extendedInfo
optional

string

productCode
optional

string

productId
optional

integer (int64)

quantity
optional

number (double)

receiverNumber
optional

string

receiverStatus
optional

string

segmentId
optional

integer (int64)

sourceEventId
optional

integer (int64)

workOrderId
optional

integer (int64)

3.30. ReceiverMaterialLots

Name Schema

materialLots
optional

< MaterialLots > array

receiverNumber
optional

string

receiverStatus
optional

string

receiverStatusId
optional

integer (int64)

receiverUnitId
optional

integer (int64)

sourceEventId
optional

integer (int64)

timeStampValue
optional

string

3.31. ReceiverMaterialLotsDto

Name Schema

materialLots
optional

< MaterialLotsDto > array

operationName
optional

string

receiverNumber
optional

string

receiverStatus
optional

string

receiverStatusId
optional

integer (int64)

receiverUnitId
optional

integer (int64)

sampleQuantity
optional

integer (int64)

segmentId
optional

integer (int64)

sourceEventId
optional

integer (int64)

timeStampValue
optional

string

workOrderId
optional

integer (int64)

workOrderName
optional

string

3.32. ReceiverMaterialLotsInfo

Name Description Schema

materialLots
optional

< MaterialLotUpdate > array

receiverName
optional

receiverName

string

receiverStatusId
optional

integer (int64)

receiverUnitId
optional

integer (int64)

3.33. SampleMaterialLotId

Sample material lot Id.

Name Description Schema

materialLotId
optional

The Id of Material Lot

integer (int64)

3.34. SampleMaterialLotResult

Get Sample material lot.

Name Description Schema

endTime
optional

The end time of the Sample

string

materialLotId
optional

The Id of the Sample Material Lot

integer (int64)

receiverId
optional

The Id of the parent receiver

integer (int64)

sampleId
optional

The Id of the Sample

integer (int64)

sampleName
optional

The name of the Sample

string

startTime
optional

The start time of the Sample

string

unitId
optional

The Id of the Sample Material Lot

integer (int64)

3.35. SampleMaterialLotUpdateInfo

Sample update data tranfer object

Name Description Schema

sampleName
optional

Name of the sample

string

3.36. SampleTestMaterialLotResult

Name Description Schema

endTime
optional

The end time of the Sample

string

materialLotId
optional

The Id of the Sample Material Lot

integer (int64)

receiverId
optional

The Id of the parent receiver

integer (int64)

sampleId
optional

The Id of the Sample

integer (int64)

sampleName
optional

The name of the Sample

string

startTime
optional

The start time of the Sample

string

tests
optional

< TestMaterialLotResult > array

3.37. SampleTestMaterialLots

Name Schema

commentId
optional

integer (int64)

materialLot
optional

string

materialLotId
optional

integer (int64)

materialLotStatus
optional

string

materialLotStatusId
optional

integer (int64)

productCode
optional

string

productDescription
optional

string

quantity
optional

number (double)

samples
optional

< Samples > array

3.38. Samples

Name Schema

autoGeneratedSample
optional

boolean

sample
optional

string

sampleId
optional

integer (int64)

tests
optional

< Tests > array

3.39. StatusCombination

Name Schema

fromStatusDescription
optional

string

fromStatusId
optional

integer (int32)

toStatusDescription
optional

string

toStatusId
optional

integer (int32)

3.40. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

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

3.41. TestMaterialLotInfoRequest

Name Schema

eventId
optional

integer (int64)

receiverId
optional

integer (int64)

testValue
optional

string

variableId
optional

integer (int32)

3.42. TestMaterialLotResult

Name Description Schema

cancelled
required

Cancelled

boolean

eventId
required

Event Id

integer (int64)

resultOn
required

result On

string

testId
required

Test Id

integer (int64)

testValue
required

Name of test value

string

variableId
required

Variable Id

integer (int32)

3.43. TestValueSpecifications

Name Schema

dataTypeId
optional

integer (int64)

eSignatureLevel
optional

integer (int64)

id
optional

integer (int64)

isInclusiveSpecCalc
optional

boolean

lowerControlLimit
optional

object

lowerEntryLimit
optional

object

lowerRejectLimit
optional

object

lowerUserLimit
optional

object

lowerWarningLimit
optional

object

target
optional

object

targetControl
optional

object

targetFreq
optional

integer (int32)

upperControlLimit
optional

object

upperEntryLimit
optional

object

upperRejectLimit
optional

object

upperUserLimit
optional

object

upperWarningLimit
optional

object

variableId
optional

integer (int64)

3.44. Tests

Name Schema

commentId
optional

integer (int64)

dataType
optional

string

dataTypeId
optional

integer (int64)

requiresInspection
optional

boolean

specDesc
optional

string

testId
optional

integer (int64)

userDefined1
optional

string

value
optional

string

varAlias
optional

string

varPrecision
optional

integer (int32)

variable
optional

string

variableId
optional

integer (int64)

3.45. TransactionStatus

Name Schema

links
optional

< Link > array

plannedUnitId
optional

integer (int64)

prodExecutionTransitions
optional

< StatusCombination > array

3.46. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

3.47. ValidationRequestInfo

Name Description Schema

materialLotNames
optional

< string > array

newLotStatusId
optional

Status ID of the material lot to be updated

integer (int32)

plannedUnitId
optional

integer (int64)

productId
optional

integer (int64)

receiverId
optional

Receiver ID of the material lot to be updated

integer (int64)

transNum
optional

TransNum value to determine the type of validation to perform

enum (1, 2)

3.48. VariableDetailsWithSpecs

Name Schema

activityId
optional

integer (int64)

actualValue
optional

string

dataTypeId
optional

integer (int32)

disable
optional

boolean

isUserDefinedDataType
optional

boolean

keyId1
optional

integer (int64)

lowerRejectValue
optional

string

targetValue
optional

string

upperRejectValue
optional

string

varId
optional

integer (int64)

variableName
optional

string

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : https://pawin2k19-2/uaa/oauth/authorize
Token URL : https://pawin2k19-2/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : https://pawin2k19-2/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : https://pawin2k19-2/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : https://pawin2k19-2/uaa/oauth/token

Name Description

default

Default oauth2 scope.