Inspection Status Resource¶
Get Inspection Status¶
HTTP Request
GET /api/inspectionStatuses/{id}
📋 Description: Retrieves the details of a specific inspection status by its unique identifier, enabling users to access current status information for effective decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "inspectionStatusType": "string",
10 "isDefaultType": true
11}
Update Inspection Status¶
HTTP Request
PUT /api/inspectionStatuses/{id}
📋 Description: Updates the status of a specific inspection identified by its unique ID, enabling users to reflect changes in inspection outcomes and maintain accurate records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated inspection status information, including relevant details such as status description and timestamps, to ensure accurate tracking and reporting of inspection activities. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "inspectionStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Inspection Status¶
HTTP Request
DELETE /api/inspectionStatuses/{id}
📋 Description: Deletes a specific inspection status identified by the provided ID, ensuring the removal of outdated or irrelevant data from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Inspection Status¶
HTTP Request
GET /api/inspectionStatuses
📋 Description: Fetches the current statuses of inspections, providing users with real-time visibility into inspection progress and outcomes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
isAvailable |
query |
boolean |
false |
Whether the resource is available |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
isAvailable |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "isDefault": true,
9 "objectAvailable": true,
10 "inspectionStatusType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the current status of an inspection, including relevant metadata to facilitate tracking and reporting within compliance and quality assurance processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the object is available for inspection, facilitating efficient resource allocation and management. |
» inspectionStatusType |
string |
false |
none |
Type of the inspection status |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Inspection Status¶
HTTP Request
POST /api/inspectionStatuses
📋 Description: Creates a new inspection status record, enabling the tracking and management of inspection processes within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the inspection status details, including relevant identifiers and status updates essential for tracking inspection progress. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "inspectionStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get All Inspection Status Type¶
HTTP Request
GET /api/inspectionStatuses/inspectionStatusType
📋 Description: Retrieves the available inspection status types, providing essential information for managing and tracking inspection processes effectively.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "DRAFT"
3]