Inspection Priority Resource¶
Get Inspection Priority¶
HTTP Request
GET /api/inspectionPriorities/{id}
📋 Description: Retrieves the details of a specific inspection priority identified by the provided ID, enabling users to access critical information for effective prioritization and resource allocation.
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 "inspectionPriorityType": "string",
10 "isDefaultType": true
11}
Update Inspection Priority¶
HTTP Request
PUT /api/inspectionPriorities/{id}
📋 Description: Updates the inspection priority associated with the specified ID, allowing users to modify existing priorities to align with changing business needs.
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 priority details, including priority level and associated metadata, for the specified inspection ID. |
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 "inspectionPriorityType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Inspection Priority¶
HTTP Request
DELETE /api/inspectionPriorities/{id}
📋 Description: Deletes a specified inspection priority from the system, ensuring that outdated or unnecessary priorities are effectively removed to maintain data integrity and streamline inspection processes.
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 Priority¶
HTTP Request
GET /api/inspectionPriorities
📋 Description: Fetches the list of inspection priorities, enabling users to identify and prioritize inspections based on predefined criteria.
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 "inspectionPriorityType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the priority level assigned to inspections, facilitating efficient resource allocation and scheduling within operational workflows.] |
|
» 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 priority management in operational workflows. |
» inspectionPriorityType |
string |
false |
none |
Type of the inspection priority |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Inspection Priority¶
HTTP Request
POST /api/inspectionPriorities
📋 Description: Creates a new inspection priority within the system, enabling organizations to effectively manage and prioritize inspection tasks based on their operational needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the inspection priority criteria, including priority levels and associated metadata for effective resource allocation. |
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 "inspectionPriorityType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}