1. Overview
Microservice containing the business logic for managing non-conformances during production.
1.2. Tags
-
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-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
2. Resources
2.1. Context-type-controller
Context Type Controller
2.1.1. Get ContextType records
GET /contexttypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.1.2. Get ContextType record by id
GET /contexttypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Id of the DispositionType as a filter . |
integer (int64) |
2.2. Defect-controller
Defect Controller
2.2.1. Get defect records
GET /nonconformances/{nonconformanceId}/defects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.2.2. List of defects
POST /nonconformances/{nonconformanceId}/defects/createDefects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.2.3. Get defect record
GET /nonconformances/{nonconformanceId}/defects/{defectId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.2.4. defect
PUT /nonconformances/{nonconformanceId}/defects/{defectId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.2.5. Disposition actions
POST /nonconformances/{nonconformanceId}/defects/{defectId}/dispositionActions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.2.6. Disposition actions
GET /nonconformances/{nonconformanceId}/defects/{defectId}/dispositionActions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.3. Defect-search-controller
Defect Search Controller
2.3.1. Get defect records
GET /defects
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.3.2. Get defects for list of defectIds
GET /defects/defectqueuesearch
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.3.3. getDefectIds
GET /defects/getDefectIds
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.3.4. getDefectIdsPaginated
GET /defects/getDefectIdsPaginated
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.3.5. Get defects for list of defectIds
GET /defects/getDefects
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
defectId |
List of Defect ID’s for the Defects 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) |
|
2.4. Defect-type-controller
Defect Type Controller
2.4.1. Create a DefectType
POST /DefectTypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.4.2. Get all DefectType records
GET /DefectTypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.4.3. Delete all DefectType
DELETE /DefectTypes
2.4.4. Get a DefectType record by id
GET /DefectTypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.4.5. Update a DefectType
PUT /DefectTypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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. Disposition-action-controller
Disposition Action Controller
2.5.1. Create a disposition action
POST /dispositionplans/{dispositionPlanId}/dispositionactions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.5.2. Get disposition actions
GET /dispositionplans/{dispositionPlanId}/dispositionactions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.5.3. Create disposition actions
POST /dispositionplans/{dispositionPlanId}/dispositionactions/createdispositionactions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.5.4. Update disposition action
PUT /dispositionplans/{dispositionPlanId}/dispositionactions/{dispositionActionId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.5.5. getDefects
GET /dispositionplans/{dispositionPlanId}/dispositionactions/{dispositionActionId}/defects
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.5.6. Get disposition action
GET /dispositionplans/{dispositionPlanId}/dispositionactions/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.6. Disposition-action-search-controller
Disposition Action Search Controller
2.6.1. Get disposition actions by query
GET /dispositionActions/getDispositionActionsByQuery
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.7. Disposition-plan-controller
Disposition Plan Controller
2.7.1. Create DispositionPlan
POST /dispositionplans
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.7.2. Get DispositionPlan records
GET /dispositionplans
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.7.3. deleteAllDispositionPlans
DELETE /dispositionplans
2.7.4. Get DispositionPlan record by id
GET /dispositionplans/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.7.5. Update DispositionPlan
PUT /dispositionplans/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.7.6. deleteDispositionPlan
DELETE /dispositionplans/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Id of the DispositionPlan resource for delete. |
integer (int64) |
2.8. Disposition-type-controller
Disposition Type Controller
2.8.1. Endpoint to create Disposition Type
POST /dispositiontypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.8.2. Get Disposition types
GET /dispositiontypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
2.8.3. deleteAllDispositionTypes
DELETE /dispositiontypes
2.8.4. Endpoint to update Disposition Type
PATCH /dispositiontypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.8.5. Get Disposition type
GET /dispositiontypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Id of the DispositionType as a filter . |
integer (int64) |
2.8.6. Endpoint to update Disposition Type
PUT /dispositiontypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.8.7. deleteDispositionType
DELETE /dispositiontypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Id of the DispositionType to delete . |
integer (int64) |
2.9. History-controller
History Controller
2.9.1. Get defect history based on Defect ID
GET /history/defecthistory/{id}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.9.2. Get disposition action history based on Defect ID or Non-Conformance ID
GET /history/dispositionactionhistory/{id}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.10. Ncm-patch-controller
NCM Patch Controller
2.10.1. Get defect records
PATCH /ncmpatch/modifydispositionplan
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.11. Non-conformance-controller
Non Conformance Controller
2.11.1. Create a nonconformance
POST /nonconformances
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.11.2. Get all nonconformances
GET /nonconformances
Parameters
| Type | Name | Schema | Default |
|---|---|---|---|
Query |
page |
integer (int32) |
|
Query |
size |
integer (int32) |
|
2.11.3. deleteAllNonconformances
DELETE /nonconformances
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
409 |
Found child resource on non-conformance, cannot be deleted |
No Content |
2.11.4. Get all nonconformances
GET /nonconformances/nonconformancesearchqueue
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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.11.5. Get nonconformance by id
GET /nonconformances/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Id of the nonconformance record to return. |
integer (int64) |
2.11.6. Update a nonconformance
PUT /nonconformances/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.11.7. deleteNonconformance
DELETE /nonconformances/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
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.12. Non-conformance-type-controller
Non Conformance Type Controller
2.12.1. Create a nonconformance type
POST /nonconformance-types
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
typeInfo |
Details on the NonConformanceType to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
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.12.2. Get all nonconformance types
GET /nonconformance-types
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
paze |
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.12.3. Get nonconformance type
GET /nonconformance-types/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
ID for the NonconformanceType as a filter. |
integer (int64) |
2.12.4. Update nonconformance type
PUT /nonconformance-types/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
ID for the NonconformanceType to update. |
integer (int64) |
Body |
typeInfo |
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.12.5. deleteNonConformanceType
DELETE /nonconformance-types/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
ID for the NonconformanceType to delete. |
integer (int64) |
3. Definitions
3.1. 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.2. 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.3. ContextTypePage
| Name | Schema |
|---|---|
content |
< ContextTypeResource > array |
links |
< Link > array |
page |
3.4. 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.5. 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.6. DefectHistoryPage
| Name | Schema |
|---|---|
content |
< DefectHistoryResource > array |
links |
< Link > array |
page |
3.7. 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.8. DefectInfo
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
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.9. DefectPage
| Name | Schema |
|---|---|
content |
< DefectResource > array |
links |
< Link > array |
page |
3.10. 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) |
value |
string |
version |
integer (int32) |
3.11. DefectResource
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
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.12. 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) |
version |
integer (int32) |
3.13. DefectTypePage
| Name | Schema |
|---|---|
content |
< DefectTypeResource > array |
links |
< Link > array |
page |
3.14. 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) |
version |
integer (int32) |
3.15. 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.16. DispositionActionHistoryPage
| Name | Schema |
|---|---|
content |
< DispositionActionHistoryResource > array |
links |
< Link > array |
page |
3.17. 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.18. DispositionActionInfo
| Name | Schema |
|---|---|
actionNote |
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.19. DispositionActionPage
| Name | Schema |
|---|---|
content |
< DispositionActionResource > array |
links |
< Link > array |
page |
3.20. DispositionActionResource
| Name | Schema |
|---|---|
actionNote |
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.21. DispositionPatch
| Name | Schema |
|---|---|
defectId |
integer (int64) |
dispositionActionId |
integer (int64) |
dispositionPlanId |
integer (int64) |
nonconformanceId |
integer (int64) |
3.22. 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.23. DispositionPlanPage
| Name | Schema |
|---|---|
content |
< DispositionPlanResource > array |
links |
< Link > array |
page |
3.24. 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.25. DispositionTypeInfo
| Name | Schema |
|---|---|
contextType |
< ContextType > array |
createdBy |
string |
createdOn |
string (date-time) |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
nameGlobal |
string |
parentId |
integer (int64) |
requiresReview |
boolean |
version |
integer (int32) |
3.26. DispositionTypeInfoExtend
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
nameGlobal |
string |
parentId |
integer (int64) |
requiresReview |
boolean |
version |
integer (int32) |
3.27. DispositionTypePage
| Name | Schema |
|---|---|
content |
< DispositionTypeResource > array |
links |
< Link > array |
page |
3.28. DispositionTypePatch
| Name | Schema |
|---|---|
contextTypeId |
integer (int64) |
dispositionTypeId |
integer (int64) |
3.29. DispositionTypeResource
| Name | Schema |
|---|---|
contextType |
< ContextType > array |
createdBy |
string |
createdOn |
string (date-time) |
dispositionTypeId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
nameGlobal |
string |
parentId |
integer (int64) |
requiresReview |
boolean |
version |
integer (int32) |
3.30. 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.31. EntityModel«DefectInfo»
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
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.32. 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.33. 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.34. NonConformancePage
| Name | Schema |
|---|---|
content |
< NonConformanceResource > array |
links |
< Link > array |
page |
3.35. 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.36. NonConformanceTypeInfo
| Name | Description | Schema |
|---|---|---|
createdBy |
string |
|
createdOn |
string (date-time) |
|
deleted |
Example : |
boolean |
description |
string |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
nonConformanceType |
string |
|
nonConformanceTypeId |
integer (int64) |
|
parentId |
integer (int64) |
|
templates |
< string > array |
|
version |
integer (int32) |
3.37. NonConformanceTypePage
| Name | Schema |
|---|---|
content |
< NonConformanceTypeResource > array |
links |
< Link > array |
page |
3.38. NonConformanceTypeResource
| Name | Description | Schema |
|---|---|---|
createdBy |
string |
|
createdOn |
string (date-time) |
|
deleted |
Example : |
boolean |
description |
string |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
links |
< Link > array |
|
nonConformanceType |
string |
|
nonConformanceTypeId |
integer (int64) |
|
parentId |
integer (int64) |
|
templates |
< string > array |
|
version |
integer (int32) |
3.39. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.40. Pageable
| Name | Schema |
|---|---|
offset |
integer (int64) |
pageNumber |
integer (int32) |
pageSize |
integer (int32) |
paged |
boolean |
sort |
|
unpaged |
boolean |
3.41. 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.42. 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) |
value |
string |
version |
integer (int32) |
3.43. 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.45. TemplateVariable
| Name | Schema |
|---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.46. UriTemplate
| Name | Schema |
|---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://10.181.213.135/uaa/oauth/authorize
Token URL : https://10.181.213.135/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://10.181.213.135/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://10.181.213.135/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://10.181.213.135/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |