1. Overview
Microservice containing the business logic for managing non-conformances during production.
1.2. Tags
-
change-specification-controller : Change Specification Controller
-
context-type-controller : Context Type Controller
-
defect-controller : Defect Controller
-
defect-search-controller : Defect Search Controller
-
defect-type-controller : Defect Type Controller
-
disposition-action-controller : Disposition Action Controller
-
disposition-action-search-controller : Disposition Action Search Controller
-
disposition-behavior-type-controller : Disposition Behavior Type Controller
-
disposition-plan-controller : Disposition Plan Controller
-
disposition-type-controller : Disposition Type Controller
-
history-controller : History Controller
-
ncm-patch-controller : NCM Patch Controller
-
non-conformance-controller : Non Conformance Controller
-
non-conformance-type-controller : Non Conformance Type Controller
-
revision-history-controller : Revision History Controller
2. Resources
2.1. Change-specification-controller
Change Specification Controller
2.1.1. Create a change specification
POST /change-specification
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
changeSpecificationInfo |
ChangeSpecification details to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.2. Get all change specification names
GET /change-specification/changeSpecificationNames
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.3. Get a change specification by Id
GET /change-specification/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
id |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.4. Update a change specification
PUT /change-specification/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
id |
integer (int64) |
Body |
changeSpecificationInfo |
ChangeSpecification details to update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.2. Context-type-controller
Context Type Controller
2.2.1. Get ContextType records
GET /contexttypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.2.2. Get ContextType record by id
GET /contexttypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of the DispositionType as a filter . |
integer (int64) |
2.3. Defect-controller
Defect Controller
2.3.1. Get defect records
GET /nonconformances/{nonconformanceId}/defects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
nonconformanceId |
Get all defect records for a nonconfomance. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Non-conformance not found |
No Content |
401 |
Unauthorized |
No Content |
2.3.2. List of defects
POST /nonconformances/{nonconformanceId}/defects/createDefects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
nonconformanceId |
Id of the Nonconformance resource. |
integer (int64) |
Body |
defect |
List of Defect details to create. |
< DefectInfo > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
< DefectResource > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Non-conformance not found |
No Content |
409 |
URL nc-id doesn’t match with request body nc-id |
No Content |
2.3.3. Get defect record
GET /nonconformances/{nonconformanceId}/defects/{defectId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
defectId |
ID for the Defect as a filter. |
integer (int64) |
Path |
nonconformanceId |
ID for the Nonconformance as a filter for defect. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
non-conformance with given id doesn’t exists |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
409 |
Wrong non-conformance for this defect |
No Content |
2.3.4. defect
PUT /nonconformances/{nonconformanceId}/defects/{defectId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
defectId |
ID of the Defect to update. |
integer (int64) |
Path |
nonconformanceId |
Id of the Nonconformance resource. |
integer (int64) |
Body |
defect |
DefectInfo Details to update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
412 |
Defect has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.3.5. Disposition actions
POST /nonconformances/{nonconformanceId}/defects/{defectId}/dispositionActions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
defectId |
ID for the Defect to map DispositionAction. |
integer (int64) |
Path |
nonconformanceId |
ID for the NonconformanceId as associated with defect. |
integer (int64) |
Query |
dispositionPlanId |
Id for the disposition planId to know defect is associated with which plan |
integer (int64) |
Body |
listDispositionAction |
Details of the dispositionAction to dispose defect |
< DispositionActionInfo > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< DispositionActionResource > array |
208 |
Disposition action already mapped to defect |
< DispositionActionResource > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
412 |
Defect has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.3.6. Disposition actions
GET /nonconformances/{nonconformanceId}/defects/{defectId}/dispositionActions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
defectId |
ID of the Defect as a filter. |
integer (int64) |
Path |
nonconformanceId |
ID of the NonconformanceId as a filter. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< DispositionActionResource > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
412 |
Defect has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.4. Defect-search-controller
Defect Search Controller
2.4.1. Get defect records
GET /defects
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
affectedObjectId |
affected Object Id of the Defect as a filter. |
< string > array(multi) |
|
Query |
affected_quantity |
Number of Affected_quantity for the defect. |
< number (double) > array(multi) |
|
Query |
defectContextType |
defect context Id of the Defect as a filter. |
< string > array(multi) |
|
Query |
id |
ID for the Defect as a filter. |
< integer (int64) > array(multi) |
|
Query |
likeOnColumn |
On column which like operator is affected. |
string |
|
Query |
likeSearchValue |
On column which like search is applied. |
string |
|
Query |
modified_by |
User that last modified the Defect. |
< string > array(multi) |
|
Query |
modified_on |
Date that the Defect was last modified. |
< string > array(multi) |
|
Query |
nonConformanceId |
Id of the NonConformance resource. |
< integer (int64) > array(multi) |
|
Query |
orderBy |
enum (asc, desc) |
|
|
Query |
orderByColumn |
Name of the column to sort based on like lastModifiedOn. |
string |
|
Query |
page |
integer (int32) |
|
|
Query |
size |
integer (int32) |
|
|
Query |
status |
Status of the Defect as a filter. Multiple values are supported. and the results contain all operations matching any of the values. Available values: Submitted, Planned, Active, Closed, Not a defect |
< string > array(multi) |
|
Query |
summary |
Summary of the Defect as a filter. |
< string > array(multi) |
2.4.2. Get defects for list of defectIds
GET /defects/defectqueuesearch
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
assigneeUserName |
Search Defect with Assignee User Name |
string |
|
Query |
defectId |
List of Defect ID’s for the DefectQueue Search as a filter. |
< integer (int64) > array(multi) |
|
Query |
page |
integer (int32) |
|
|
Query |
searchQueue |
Search Defect with NCR name and Dispostion Plan Name |
string |
|
Query |
size |
integer (int32) |
|
|
Query |
status |
Status of the Defect as a filter. Multiple values are supported. and the results contain all operations matching any of the values. Available values: Submitted, Planned, Active, Closed, Not a defect |
< string > array(multi) |
2.4.3. getDefectIds
GET /defects/getDefectIds
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
affectedObjectId |
affectedObjectId |
< string > array(multi) |
|
Query |
affected_object_type |
affected_object_type |
< string > array(multi) |
|
Query |
affected_quantity |
affected_quantity |
< number (double) > array(multi) |
|
Query |
defect_context_type |
defect_context_type |
< string > array(multi) |
|
Query |
id |
id |
< integer (int64) > array(multi) |
|
Query |
likeOnColumn |
likeOnColumn |
string |
|
Query |
likeSearchValue |
likeSearchValue |
string |
|
Query |
modified_by |
modified_by |
< string > array(multi) |
|
Query |
modified_on |
modified_on |
< string > array(multi) |
|
Query |
nonConformanceId |
nonConformanceId |
< integer (int64) > array(multi) |
|
Query |
orderBy |
enum (asc, desc) |
|
|
Query |
orderByColumn |
orderByColumn |
string |
|
Query |
status |
status |
< string > array(multi) |
|
Query |
summary |
summary |
< string > array(multi) |
2.4.4. getDefectIdsPaginated
GET /defects/getDefectIdsPaginated
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
affected_object_type |
affected object type of defect as a filter |
< string > array(multi) |
|
Query |
affected_quantity |
Number of Affected_quantity for the defect. |
< number (double) > array(multi) |
|
Query |
defect_context_type |
Defect context type of defect as a filter |
< string > array(multi) |
|
Query |
id |
ID for the List of Defect as a filter. |
< integer (int64) > array(multi) |
|
Query |
likeOnColumn |
On column which like operator is affected. |
string |
|
Query |
likeSearchValue |
On column which like search is applied. |
string |
|
Query |
modified_by |
List of Users that last modified the Defect. |
< string > array(multi) |
|
Query |
modified_on |
List of Dates that the Defect was last modified. |
< string > array(multi) |
|
Query |
nonConformanceId |
Id of the NonConformance resource. |
< integer (int64) > array(multi) |
|
Query |
orderBy |
enum (asc, desc) |
|
|
Query |
orderByColumn |
Name of the column to sort based on like lastModifiedOn. |
string |
|
Query |
page |
integer (int32) |
|
|
Query |
size |
integer (int32) |
|
|
Query |
status |
Status of the Defect as a filter. Multiple values are supported. and the results contain all operations matching any of the values. Available values: Submitted, Planned, Active, Closed, Not a defect |
< string > array(multi) |
|
Query |
summary |
Summary of the Defect as a filter. |
< string > array(multi) |
2.4.5. Get defects for list of defectIds
GET /defects/getDefects
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
defectId |
List of Defect ID’s for the Defects as a filter. |
< integer (int64) > array(multi) |
|
Query |
excludeDispositionActions |
Exclude disposition actions in response. |
boolean |
|
Query |
page |
integer (int32) |
|
|
Query |
searchQueue |
Search Defect with NCR name and Dispostion Plan Name |
string |
|
Query |
size |
integer (int32) |
|
2.5. Defect-type-controller
Defect Type Controller
2.5.1. Create a DefectType
POST /DefectTypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
record |
Record Info representing the DefectType to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied: must not set DefectTypeId property |
No Content |
401 |
Unauthorized |
No Content |
2.5.2. Get all DefectType records
GET /DefectTypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
Query |
type |
DefectType of the operation as a filter, different values are supported like All,false,true |
enum (true, false) |
|
2.5.3. Delete all DefectType
DELETE /DefectTypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
2.5.4. Soft Delete a DefectType
DELETE /DefectTypes/softdelete/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID of the DefectType to Soft Delete. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
object |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
406 |
Not acceptable |
No Content |
412 |
DefectType has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.5.5. Get a DefectType record by id
GET /DefectTypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID for the DefectType that the defect belongs as a filter Like: Locking unmatched,Paint Shop Defect,Welding Shop Defect |
integer (int64) |
2.5.6. Update a DefectType
PUT /DefectTypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID of the DefectType to update. |
integer (int64) |
Body |
record |
Record Info representing the DefectType to Update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
412 |
DefectType has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.5.7. Delete a DefectType
DELETE /DefectTypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID of the DefectType to Delete. |
integer (int64) |
2.6. Disposition-action-controller
Disposition Action Controller
2.6.1. Create a disposition action
POST /dispositionplans/{dispositionPlanId}/dispositionactions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
dispositionPlanId |
Id of the dispositionPlan resource. |
integer (int64) |
Body |
record |
Details of the DispositionActionInfo to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied: must not set dispositionActionId property |
No Content |
401 |
Unauthorized |
No Content |
404 |
Parent disposition-plan id does not exist |
No Content |
2.6.2. Get disposition actions
GET /dispositionplans/{dispositionPlanId}/dispositionactions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
dispositionPlanId |
ID for the dispositionPlan as a filter for dispositionActions. |
integer (int64) |
|
Query |
page |
integer (int32) |
|
|
Query |
size. |
Number of resources to return per page. |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Non-conformance not found |
No Content |
401 |
Unauthorized |
No Content |
2.6.3. Create disposition actions
POST /dispositionplans/{dispositionPlanId}/dispositionactions/createdispositionactions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
dispositionPlanId |
Id of the dispositionPlan resource. |
integer (int64) |
Body |
record |
List of Details of dispositionAction to create. |
< DispositionActionInfo > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
< DispositionActionResource > array |
400 |
Invalid data supplied: must not set dispositionActionId property |
No Content |
401 |
Unauthorized |
No Content |
404 |
Parent disposition-plan id does not exist |
No Content |
2.6.4. Update disposition action
PUT /dispositionplans/{dispositionPlanId}/dispositionactions/{dispositionActionId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
dispositionActionId |
Id of the dispositionAction to Update. |
integer (int64) |
Path |
dispositionPlanId |
Id of the dispositionPlan resource to update. |
integer (int64) |
Body |
record |
Details of the DispositionActionInfo to Update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
409 |
Disposition Action belongs to some other disposition plan |
No Content |
412 |
DispositionAction has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.6.5. getDefects
GET /dispositionplans/{dispositionPlanId}/dispositionactions/{dispositionActionId}/defects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
dispositionActionId |
ID for the dispositionAction as a filter. |
integer (int64) |
Path |
dispositionPlanId |
ID for the dispositionPlanId as a filter. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< EntityModel«DefectInfo» > array |
400 |
Non-conformance not found |
No Content |
401 |
Unauthorized |
No Content |
2.6.6. Get disposition action
GET /dispositionplans/{dispositionPlanId}/dispositionactions/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
dispositionPlanId |
ID for the dispositionPlan as a filter for dispositionActions. |
integer (int64) |
Path |
id |
ID of the DispositionAction as a filter. |
integer (int64) |
2.7. Disposition-action-search-controller
Disposition Action Search Controller
2.7.1. Get disposition actions by query
GET /dispositionActions/getDispositionActionsByQuery
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
dispositionType |
List of DispositionTypes Like: clear,CTP,rework,scrap and use as is. |
< string > array(multi) |
|
Query |
id |
List of Id’s of the DispositionActions resource. |
< integer (int64) > array(multi) |
|
Query |
modified_by |
List of User’s that last modified the Defect. |
< string > array(multi) |
|
Query |
modified_on |
List of Dates that the Defect was last modified. |
< string > array(multi) |
|
Query |
orderBy |
Name of the operation property to sort the results by. |
string |
|
Query |
orderByColumn |
Name of the column to sort based on like lastModifiedOn. |
string |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
propDefinition |
propDefinition |
< string > array(multi) |
|
Query |
propValue |
propValue |
< string > array(multi) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
Query |
status |
Status of the DispositionAction as a filter. Multiple values are supported |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Non-conformance not found |
No Content |
401 |
Unauthorized |
No Content |
2.8. Disposition-behavior-type-controller
Disposition Behavior Type Controller
2.8.1. Get Disposition Behavior type records
GET /dispositionBehaviorType
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.9. Disposition-plan-controller
Disposition Plan Controller
2.9.1. Create DispositionPlan
POST /dispositionplans
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
record |
Details on the DispositionPlanInfo to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied: must not set dispositionPlanId property |
No Content |
401 |
Unauthorized |
No Content |
2.9.2. Get DispositionPlan records
GET /dispositionplans
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
dispositionActionStatus |
DispositionActionStatus of the operation as a filter,different values are supported like ALL,Open |
enum (Open, All) |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.9.3. deleteAllDispositionPlans
DELETE /dispositionplans
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
2.9.4. Get DispositionPlan record by id
GET /dispositionplans/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of the dispositionPlan resource. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Invalid data supplied: must not set dispositionPlanId property |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
2.9.5. Update DispositionPlan
PUT /dispositionplans/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of the dispositionPlan resource. |
integer (int64) |
Body |
record |
Details on the DispositionPlanInfo to Update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
412 |
DispositionPlan has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.9.6. deleteDispositionPlan
DELETE /dispositionplans/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of the DispositionPlan resource for delete. |
integer (int64) |
2.10. Disposition-type-controller
Disposition Type Controller
2.10.1. Endpoint to create Disposition Type
POST /dispositiontypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
record |
Details on the DispositionType to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied: must not set dispositionTypeId property |
No Content |
401 |
Unauthorized |
No Content |
409 |
Type with that name already exists |
No Content |
2.10.2. Get Disposition types
GET /dispositiontypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
Query |
type |
DispositionType of the operation as a filter, different values are supported like All,false,true |
enum (true, false) |
|
2.10.3. Endpoint to update Disposition Type
PUT /dispositiontypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
record |
Detail of Disposition Type to be update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
406 |
Not acceptable |
No Content |
412 |
DispositionType has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.10.4. deleteAllDispositionTypes
DELETE /dispositiontypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
2.10.5. Endpoint to update Disposition Type
PATCH /dispositiontypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
record |
Detail of Disposition Type to be update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
406 |
Not acceptable |
No Content |
412 |
DispositionType has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.10.6. Soft delete disposition type
DELETE /dispositiontypes/softdelete/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id Required for soft delete of disposition type |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
object |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
406 |
Not acceptable |
No Content |
412 |
DispositionType has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.10.7. Get disposition types property groups
GET /dispositiontypes/{dispositionTypeId}/propertyGroups
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
dispositionTypeId |
disposition type id |
integer (int64) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< DispositionTypePropertyGroupInfo > array |
401 |
Unauthorized |
No Content |
2.10.8. Get Disposition type
GET /dispositiontypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of the DispositionType as a filter . |
integer (int64) |
2.10.9. Endpoint to update Disposition Type
PUT /dispositiontypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of Disposition Type to be update. |
integer (int64) |
Body |
record |
Detail of Disposition Type to be update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
406 |
Not acceptable |
No Content |
412 |
DispositionType has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.10.10. deleteDispositionType
DELETE /dispositiontypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of the DispositionType to delete . |
integer (int64) |
2.11. History-controller
History Controller
2.11.1. Get defect history based on Defect ID
GET /history/defecthistory/{id}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
id |
ID for the Defect as a filter. |
integer (int64) |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
defect history not found |
No Content |
401 |
Unauthorized |
No Content |
2.11.2. Get disposition action history based on Defect ID or Non-Conformance ID
GET /history/dispositionactionhistory/{id}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
id |
id must be a Non-Conformance ID or Defect ID |
integer (int64) |
|
Query |
idIs |
idIs |
enum (DefectId, NonConformanceId) |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
dispostionAction history not found |
No Content |
401 |
Unauthorized |
No Content |
2.12. Ncm-patch-controller
NCM Patch Controller
2.12.1. Get defect records
PATCH /ncmpatch/modifydispositionplan
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
disposition |
Details on the DispositionPlan to Update. |
< DispositionPatch > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
204 |
No Content |
|
401 |
Unauthorized |
No Content |
404 |
disposition action not found |
No Content |
2.13. Non-conformance-controller
Non Conformance Controller
2.13.1. Create a nonconformance
POST /nonconformances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
record |
Details on the Nonconformance to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied: must not set nonConformanceId property |
No Content |
401 |
Unauthorized |
No Content |
404 |
Parent ncr-type not found |
No Content |
2.13.2. Get all nonconformances
GET /nonconformances
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
page |
integer (int32) |
|
|
Query |
size |
integer (int32) |
|
2.13.3. deleteAllNonconformances
DELETE /nonconformances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
409 |
Found child resource on non-conformance, cannot be deleted |
No Content |
2.13.4. Get all nonconformances
GET /nonconformances/nonconformancesearchqueue
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
defectId |
Id of the defectId record to return. |
< integer (int64) > array(multi) |
|
Query |
page |
integer (int32) |
|
|
Query |
searchQueue |
searchQueue for the Nonconformance as a filter. |
string |
|
Query |
size |
integer (int32) |
|
2.13.5. Get nonconformance by id
GET /nonconformances/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id of the nonconformance record to return. |
integer (int64) |
2.13.6. Update a nonconformance
PUT /nonconformances/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID for the Nonconformance as a filter. |
integer (int64) |
Body |
record |
Details on the Nonconformance to Update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
412 |
Non-conformance has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.13.7. deleteNonconformance
DELETE /nonconformances/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID for the Nonconformance to delete the records. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Defect not found |
No Content |
409 |
Found child resource on non-conformance, cannot be deleted |
No Content |
2.14. Non-conformance-type-controller
Non Conformance Type Controller
2.14.1. Create a nonconformance type
POST /nonconformance-types
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
nonConformanceTypeCreateRecord |
Details on the NonConformanceType to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
2001 |
Created |
No Content |
400 |
Invalid data supplied: must not set nonconformanceId or deleted properties |
No Content |
401 |
Unauthorized |
No Content |
409 |
Type with that name already exists |
No Content |
2.14.2. Get all nonconformance types
GET /nonconformance-types
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
contextType |
Context Type |
string |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
Query |
type |
NonConformanceType of the operation as a filter, different values are supported like All,false,true |
enum (true, false) |
|
2.14.3. Get nonconformance type
GET /nonconformance-types/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID for the NonconformanceType as a filter. |
integer (int64) |
2.14.4. Update nonconformance type
PUT /nonconformance-types/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID for the NonconformanceType to update. |
integer (int64) |
Body |
nonConformanceTypeCreateRecord |
Details on the NonConformanceType to Update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
409 |
Type with that name already exists |
No Content |
412 |
Type has been updated since the GET on which the submitted changes were made. Response contains the current record. |
No Content |
2.14.5. deleteNonConformanceType
DELETE /nonconformance-types/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
ID for the NonconformanceType to delete. |
integer (int64) |
2.14.6. Soft delete NC type
PATCH /nonconformance-types/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
Id Required for soft delete of NC type |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
object |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
2.15. Revision-history-controller
Revision History Controller
2.15.1. Save revision history
POST /v1/revisionhistory/
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
revisionHistory |
List of Defect details to create. |
< RevisionHistory > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Non-conformance not found |
No Content |
500 |
Internal server error |
No Content |
2.15.2. Get revision history
GET /v1/revisionhistory/{entityType}/{entityTypeId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
entityType |
Entity type e.g. 1 for nonconformance, 2 for defect, 3 for disposition…… |
integer (int64) |
|
Path |
entityTypeId |
Entity type id |
integer (int64) |
|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
successful |
|
400 |
Invalid data supplied. See message for details |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not found |
No Content |
500 |
Internal server error |
No Content |
3. Definitions
3.1. AppliesTo
| Name | Schema |
|---|---|
excludedMaterialLotActualIds |
< integer (int64) > array |
materialLotActualIds |
< integer (int64) > array |
3.2. AssociatedProduct
| Name | Schema |
|---|---|
associationId |
integer (int64) |
productId |
integer (int64) |
unitId |
integer (int64) |
3.3. BomFormulation
| Name | Schema |
|---|---|
associatedProducts |
< AssociatedProduct > array |
behaviors |
< string > array |
crossReferences |
< CrossReference > array |
effectiveDate |
string (date-time) |
expirationDate |
string (date-time) |
formulationCode |
string |
formulationDescription |
string |
formulationItems |
< FormulationItem > array |
producedQuantity |
number (double) |
producedQuantityPrecision |
integer (int32) |
producedQuantityUnitOfMeasureId |
integer (int64) |
propertyValues |
< PropertyValues > array |
schemaVersion |
integer (int64) |
3.4. ChangeSpecificationInfo
| Name | Schema |
|---|---|
bomFormulation |
|
bomFormulationId |
integer (int64) |
producedMaterialId |
integer (int64) |
schemaVersion |
integer (int32) |
segments |
< SegmentInfo > array |
specificationId |
integer (int64) |
specificationName |
string |
structure |
|
structureType |
enum (tree, simple) |
toolState |
3.5. ContextType
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
displayName |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
version |
integer (int32) |
3.6. ContextTypeInfo
| Name | Schema |
|---|---|
contextTypeId |
integer (int64) |
createdBy |
string |
createdOn |
string (date-time) |
displayName |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
requiresReview |
boolean |
version |
integer (int32) |
3.7. ContextTypePage
| Name | Schema |
|---|---|
content |
< ContextTypeResource > array |
links |
< Link > array |
page |
3.8. ContextTypeResource
| Name | Schema |
|---|---|
contextTypeId |
integer (int64) |
createdBy |
string |
createdOn |
string (date-time) |
displayName |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
requiresReview |
boolean |
version |
integer (int32) |
3.9. CrossReference
| Name | Schema |
|---|---|
externalId |
string |
externalSystemId |
integer (int64) |
3.10. DefectAssigneeInfo
| Name | Description | Schema |
|---|---|---|
assigneeGroupId |
Assignee Group Id |
string |
assigneeUserName |
Assignee User Name |
string |
3.11. DefectHistoryInfo
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectContextType |
string |
defectHistoryId |
integer (int64) |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel2Id |
string |
defectReasonLevel3Id |
string |
defectReasonLevel4Id |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
description |
string |
dispositionActionTreeId |
string |
dispositionActionsHistory |
< DispositionActionHistoryInfo > array |
dispostionActionId |
< integer (int64) > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
locationId |
string |
locationType |
string |
modifiedOn |
string (date-time) |
nonConformanceId |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
nonconformanceDescription |
string |
nonconformanceName |
string |
parentId |
integer (int64) |
propertyValuesHistory |
< PropertyValueInfo > array |
reportedBy |
string |
status |
string |
summary |
string |
version |
integer (int32) |
3.12. DefectHistoryPage
| Name | Schema |
|---|---|
content |
< DefectHistoryResource > array |
links |
< Link > array |
page |
3.13. DefectHistoryResource
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectContextType |
string |
defectHistoryId |
integer (int64) |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel2Id |
string |
defectReasonLevel3Id |
string |
defectReasonLevel4Id |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
description |
string |
dispositionActionTreeId |
string |
dispositionActionsHistory |
< DispositionActionHistoryInfo > array |
dispostionActionId |
< integer (int64) > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
locationId |
string |
locationType |
string |
modifiedOn |
string (date-time) |
nonConformanceId |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
nonconformanceDescription |
string |
nonconformanceName |
string |
parentId |
integer (int64) |
propertyValuesHistory |
< PropertyValueInfo > array |
reportedBy |
string |
status |
string |
summary |
string |
version |
integer (int32) |
3.14. DefectInfo
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
assignees |
< DefectAssigneeInfo > array |
attachments |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectContextType |
string |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel2Id |
string |
defectReasonLevel3Id |
string |
defectReasonLevel4Id |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
description |
string |
dispositionActionTreeId |
string |
dispositionActions |
< DispositionActionInfo > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
locationId |
string |
locationType |
string |
ncLastModifiedBy |
string |
ncLastModifiedOn |
string (date-time) |
nonConformanceType |
string |
nonconformanceDescription |
string |
nonconformanceId |
integer (int64) |
nonconformanceName |
string |
nonconformanceTypeId |
integer (int64) |
parentId |
integer (int64) |
propertyValues |
< DefectPropertyValueInfo > array |
reportedBy |
string |
status |
string |
summary |
string |
version |
integer (int32) |
3.15. DefectPage
| Name | Schema |
|---|---|
content |
< DefectResource > array |
links |
< Link > array |
page |
3.16. DefectPropertyValueInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
originId |
integer (int64) |
propertyDefinitionId |
string |
propertyValueId |
integer (int64) |
rowMappingIndex |
string |
value |
string |
version |
integer (int32) |
3.17. DefectResource
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
assignees |
< DefectAssigneeInfo > array |
attachments |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectContextType |
string |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel2Id |
string |
defectReasonLevel3Id |
string |
defectReasonLevel4Id |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
description |
string |
dispositionActionTreeId |
string |
dispositionActions |
< DispositionActionInfo > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
locationId |
string |
locationType |
string |
ncLastModifiedBy |
string |
ncLastModifiedOn |
string (date-time) |
nonConformanceType |
string |
nonconformanceDescription |
string |
nonconformanceId |
integer (int64) |
nonconformanceName |
string |
nonconformanceTypeId |
integer (int64) |
parentId |
integer (int64) |
propertyValues |
< DefectPropertyValueInfo > array |
reportedBy |
string |
status |
string |
summary |
string |
version |
integer (int32) |
3.18. DefectTypeInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
dispositionActionTreeId |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
parentId |
integer (int64) |
propertyValues |
< DefectTypePropertyValueInfo > array |
version |
integer (int32) |
3.19. DefectTypePage
| Name | Schema |
|---|---|
content |
< DefectTypeResource > array |
links |
< Link > array |
page |
3.20. DefectTypePropertyValueInfo
| Name | Schema |
|---|---|
propertyDefinitionId |
string |
value |
string |
3.21. DefectTypeResource
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
dispositionActionTreeId |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
parentId |
integer (int64) |
propertyValues |
< DefectTypePropertyValueInfo > array |
version |
integer (int32) |
3.22. DispositionActionHistoryInfo
| Name | Schema |
|---|---|
actionNote |
string |
affectedObjectId |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel2Id |
string |
daReasonLevel3Id |
string |
daReasonLevel4Id |
string |
defectContextType |
string |
defectId |
integer (int64) |
dispositionActionHistoryId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionActionPropertyValues |
< PropertyValueInfo > array |
dispositionPlanId |
integer (int64) |
dispositionTypeId |
integer (int64) |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
modifiedOn |
string (date-time) |
name |
string |
quantity |
number (double) |
status |
string |
version |
integer (int32) |
3.23. DispositionActionHistoryPage
| Name | Schema |
|---|---|
content |
< DispositionActionHistoryResource > array |
links |
< Link > array |
page |
3.24. DispositionActionHistoryResource
| Name | Schema |
|---|---|
actionNote |
string |
affectedObjectId |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel2Id |
string |
daReasonLevel3Id |
string |
daReasonLevel4Id |
string |
defectContextType |
string |
defectId |
integer (int64) |
dispositionActionHistoryId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionActionPropertyValues |
< PropertyValueInfo > array |
dispositionPlanId |
integer (int64) |
dispositionTypeId |
integer (int64) |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
links |
< Link > array |
modifiedOn |
string (date-time) |
name |
string |
quantity |
number (double) |
status |
string |
version |
integer (int32) |
3.25. DispositionActionInfo
| Name | Schema |
|---|---|
actionNote |
string |
attachments |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel2Id |
string |
daReasonLevel3Id |
string |
daReasonLevel4Id |
string |
dispositionActionId |
integer (int64) |
dispositionPlan |
|
dispositionPlanId |
integer (int64) |
dispositionTypeId |
integer (int64) |
dispositionTypeName |
string |
dispositionTypeNameGlobal |
string |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
name |
string |
parentId |
integer (int64) |
properties |
< PropertyValueInfo > array |
quantity |
number (double) |
status |
string |
version |
integer (int32) |
3.26. DispositionActionPage
| Name | Schema |
|---|---|
content |
< DispositionActionResource > array |
links |
< Link > array |
page |
3.27. DispositionActionResource
| Name | Schema |
|---|---|
actionNote |
string |
attachments |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel2Id |
string |
daReasonLevel3Id |
string |
daReasonLevel4Id |
string |
dispositionActionId |
integer (int64) |
dispositionPlan |
|
dispositionPlanId |
integer (int64) |
dispositionTypeId |
integer (int64) |
dispositionTypeName |
string |
dispositionTypeNameGlobal |
string |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
links |
< Link > array |
name |
string |
parentId |
integer (int64) |
properties |
< PropertyValueInfo > array |
quantity |
number (double) |
status |
string |
version |
integer (int32) |
3.28. DispositionBehaviorTypePage
| Name | Schema |
|---|---|
content |
< DispositionBehaviorTypeResource > array |
links |
< Link > array |
page |
3.29. DispositionBehaviorTypeResource
| Name | Schema |
|---|---|
contextType |
< ContextType > array |
createdBy |
string |
createdOn |
string (date-time) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
version |
integer (int32) |
3.30. DispositionPatch
| Name | Schema |
|---|---|
defectId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionPlanId |
integer (int64) |
nonconformanceId |
integer (int64) |
3.31. DispositionPlanInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionPlanId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
parentId |
integer (int64) |
requiresReview |
boolean |
reviewed |
boolean |
reviewedBy |
string |
reviewedOn |
string (date-time) |
source |
string |
status |
string |
version |
integer (int32) |
3.32. DispositionPlanPage
| Name | Schema |
|---|---|
content |
< DispositionPlanResource > array |
links |
< Link > array |
page |
3.33. DispositionPlanResource
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionPlanId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
parentId |
integer (int64) |
requiresReview |
boolean |
reviewed |
boolean |
reviewedBy |
string |
reviewedOn |
string (date-time) |
source |
string |
status |
string |
version |
integer (int32) |
3.34. DispositionTypeContextTypeId
| Name | Schema |
|---|---|
contextTypeIds |
< integer (int64) > array |
dispositionTypeId |
integer (int64) |
3.35. DispositionTypeInfo
| Name | Schema |
|---|---|
contextType |
< ContextType > array |
createdBy |
string |
createdOn |
string (date-time) |
dispositionBehaviorTypeId |
integer (int64) |
dispositionCode |
string |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
nameGlobal |
string |
parentId |
integer (int64) |
propertyValues |
< DispositionTypePropertyValueInfo > array |
requiresReview |
boolean |
version |
integer (int32) |
3.36. DispositionTypeInfoExtend
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionBehaviorTypeId |
integer (int64) |
dispositionCode |
string |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
nameGlobal |
string |
parentId |
integer (int64) |
propertyGroups |
< DispositionTypePropertyGroup > array |
propertyValues |
< DispositionTypePropertyValueInfo > array |
requiresReview |
boolean |
version |
integer (int32) |
3.37. DispositionTypePage
| Name | Schema |
|---|---|
content |
< DispositionTypeResource > array |
links |
< Link > array |
page |
3.38. DispositionTypePatch
| Name | Schema |
|---|---|
contextTypeId |
integer (int64) |
dispositionTypeId |
integer (int64) |
3.41. DispositionTypePropertyValueInfo
| Name | Schema |
|---|---|
propertyDefinitionId |
string |
value |
string |
3.42. DispositionTypeResource
| Name | Schema |
|---|---|
contextType |
< ContextType > array |
createdBy |
string |
createdOn |
string (date-time) |
dispositionBehaviorTypeId |
integer (int64) |
dispositionCode |
string |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
nameGlobal |
string |
parentId |
integer (int64) |
propertyValues |
< DispositionTypePropertyValueInfo > array |
requiresReview |
boolean |
version |
integer (int32) |
3.44. EntityModel«ContextTypeInfo»
| Name | Schema |
|---|---|
contextTypeId |
integer (int64) |
createdBy |
string |
createdOn |
string (date-time) |
displayName |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
requiresReview |
boolean |
version |
integer (int32) |
3.45. EntityModel«DefectInfo»
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
assignees |
< DefectAssigneeInfo > array |
attachments |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectContextType |
string |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel2Id |
string |
defectReasonLevel3Id |
string |
defectReasonLevel4Id |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
description |
string |
dispositionActionTreeId |
string |
dispositionActions |
< DispositionActionInfo > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
locationId |
string |
locationType |
string |
ncLastModifiedBy |
string |
ncLastModifiedOn |
string (date-time) |
nonConformanceType |
string |
nonconformanceDescription |
string |
nonconformanceId |
integer (int64) |
nonconformanceName |
string |
nonconformanceTypeId |
integer (int64) |
parentId |
integer (int64) |
propertyValues |
< DefectPropertyValueInfo > array |
reportedBy |
string |
status |
string |
summary |
string |
version |
integer (int32) |
3.46. Error
Error details.
| Name | Description | Schema |
|---|---|---|
code |
string |
|
details |
Details of the error. |
object |
3.47. FormulationItem
| Name | Schema |
|---|---|
appliesTo |
|
behaviors |
< string > array |
displayOrder |
integer (int32) |
itemId |
integer (int64) |
itemReference |
string |
locationId |
integer (int64) |
lotDescription |
string |
lowerTolerance |
number (double) |
lowerTolerancePrecision |
integer (int64) |
productId |
integer (int64) |
propertyValues |
< PropertyValues > array |
quantity |
number (double) |
quantityPrecision |
integer (int32) |
scrapFactor |
number (double) |
substitutions |
< Substitution > array |
unitId |
integer (int64) |
unitOfMeasureId |
integer (int64) |
upperTolerance |
number (double) |
upperTolerancePrecision |
integer (int64) |
3.48. FormulationItemsConsumption
| Name | Schema |
|---|---|
behaviors |
< string > array |
itemReference |
string |
lowerTolerance |
number (double) |
quantity |
number (double) |
quantityPrecision |
integer (int32) |
upperTolerance |
number (double) |
3.49. HttpErrorResponse
Http Error response.
| Name | Description | Schema |
|---|---|---|
error |
Error details |
|
path |
URL at which error occured. |
string |
timestamp |
Timestamp at which error occured |
string |
3.50. LaborPlan
| Name | Schema |
|---|---|
laborCodes |
< integer (int64) > array |
standardLaborPlan |
< LaborPlanItem > array |
3.51. LaborPlanItem
| Name | Schema |
|---|---|
basis |
enum (item, lot) |
laborPlanningTypeId |
integer (int64) |
time |
integer (int64) |
3.52. Link
| Name | Schema |
|---|---|
deprecation |
string |
href |
string |
hreflang |
string |
media |
string |
name |
string |
profile |
string |
rel |
string |
template |
|
templated |
boolean |
title |
string |
type |
string |
3.53. NonConformanceInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defectInfo |
< DefectInfo > array |
description |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
nonConformanceId |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
parentId |
integer (int64) |
propertyValues |
< PropertyValueInfo > array |
source |
string |
status |
string |
version |
integer (int32) |
3.54. NonConformancePage
| Name | Schema |
|---|---|
content |
< NonConformanceResource > array |
links |
< Link > array |
page |
3.55. NonConformanceResource
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defectInfo |
< DefectInfo > array |
description |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
nonConformanceId |
integer (int64) |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
parentId |
integer (int64) |
propertyValues |
< PropertyValueInfo > array |
source |
string |
status |
string |
version |
integer (int32) |
3.56. NonConformanceTypeCreateRecord
| Name | Schema |
|---|---|
contextTypeIds |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectTypeIds |
string |
deleted |
boolean |
description |
string |
displayName |
string |
dispositionTypeIds |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
parentId |
integer (int64) |
propertyValues |
< PropertyValues > array |
templates |
< string > array |
version |
integer (int32) |
3.57. NonConformanceTypePage
| Name | Schema |
|---|---|
content |
< NonConformanceTypeResource > array |
links |
< Link > array |
page |
3.58. NonConformanceTypeResource
| Name | Schema |
|---|---|
contextType |
< ContextTypeInfo > array |
createdBy |
string |
createdOn |
string (date-time) |
defectType |
< DefectTypeInfo > array |
deleted |
boolean |
description |
string |
displayName |
string |
dispositionType |
< DispositionTypeInfo > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
nonConformanceType |
string |
nonConformanceTypeId |
integer (int64) |
propertyValues |
< PropertyValues > array |
version |
integer (int32) |
3.59. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.60. Pageable
| Name | Schema |
|---|---|
offset |
integer (int64) |
pageNumber |
integer (int32) |
pageSize |
integer (int32) |
paged |
boolean |
sort |
|
unpaged |
boolean |
3.61. Page«long»
| Name | Schema |
|---|---|
content |
< integer (int64) > array |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer (int32) |
numberOfElements |
integer (int32) |
pageable |
|
size |
integer (int32) |
sort |
|
totalElements |
integer (int64) |
totalPages |
integer (int32) |
3.62. PlannedUnit
| Name | Schema |
|---|---|
machinePlan |
|
peoplePlan |
|
unitId |
integer (int64) |
3.63. PropertyValueInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionActionHistoryId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
originId |
integer (int64) |
parentId |
integer (int64) |
propertyDefinitionId |
string |
propertyValueId |
integer (int64) |
rowMappingIndex |
string |
value |
string |
version |
integer (int32) |
3.65. ResponseEntity
| Name | Schema |
|---|---|
body |
object |
statusCode |
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) |
statusCodeValue |
integer (int32) |
3.66. RevisionHistory
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
description |
string |
entityType |
integer (int64) |
entityTypeId |
integer (int64) |
id |
integer (int64) |
revision |
integer (int64) |
3.67. RevisionHistoryPage
| Name | Schema |
|---|---|
content |
< RevisionHistoryResource > array |
links |
< Link > array |
page |
3.68. RevisionHistoryResource
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
description |
string |
entityType |
integer (int64) |
entityTypeId |
integer (int64) |
id |
integer (int64) |
links |
< Link > array |
revision |
integer (int64) |
3.69. SegmentInfo
| Name | Schema |
|---|---|
allVariables |
< object > array |
allbomItems |
< object > array |
appliesTo |
|
behaviors |
< string > array |
dataEntryPlans |
< integer (int64) > array |
description |
string |
documents |
< Document > array |
formulationItemsConsumption |
< FormulationItemsConsumption > array |
name |
string |
plannedUnits |
< PlannedUnit > array |
propertyDefinationData |
< object > array |
propertyValues |
< PropertyValues > array |
savedDocs |
< object > array |
segmentId |
integer (int64) |
segmentType |
enum (group, route, segment) |
suggestedLaborTypes |
< integer (int64) > array |
toolCategoryIds |
< integer (int64) > array |
toolIds |
< integer (int64) > array |
3.70. SequenceElement
| Name | Schema |
|---|---|
children |
< SequenceElement > array |
displayOrder |
integer (int64) |
mutualExclusionSets |
< integer (int64) > array |
segmentId |
integer (int64) |
sequenceNumber |
integer (int64) |
skipIfSuccessorStarted |
boolean |
3.73. Substitution
| Name | Schema |
|---|---|
conversionFactor |
number (double) |
productId |
integer (int64) |
quantity |
number (double) |
quantityPrecision |
integer (int32) |
substitutionOrder |
integer (int32) |
uom |
integer (int64) |
3.74. TemplateVariable
| Name | Schema |
|---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.75. ToolState
| Name | Schema |
|---|---|
currentOperationId |
integer (int64) |
operationToolMapping |
< object > array |
operations |
< object > array |
tools |
< object > array |
3.76. UriTemplate
| Name | Schema |
|---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
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. |