Request Priority Resource¶
Get Priority¶
HTTP Request
GET /api/requestPriority/{id}
📋 Description: Retrieves the details of a specific request priority by its unique identifier, enabling users to assess and manage priority levels effectively within their operational workflows.
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 "requestPriorityType": "string",
10 "isDefaultType": true
11}
Update Priority¶
HTTP Request
PUT /api/requestPriority/{id}
📋 Description: Updates the priority level of a specific request identified by its unique ID, enabling businesses to manage and adjust request urgency effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated priority details for the specified request, including priority level and associated metadata. |
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 "requestPriorityType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Priority¶
HTTP Request
DELETE /api/requestPriority/{id}
📋 Description: Deletes a specific request priority identified by the given ID, ensuring the removal of outdated or unnecessary priorities 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 Priority¶
HTTP Request
GET /api/requestPriority
📋 Description: Fetches the current request priority settings to facilitate efficient resource allocation and decision-making within the organization.
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 "requestPriorityType": "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 of a request within the workflow management system, facilitating efficient resource allocation and task prioritization in business operations.] |
|
» 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 requested object is available for processing, facilitating efficient resource allocation and prioritization in request management. |
» requestPriorityType |
string |
false |
none |
Type of the request priority |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Priority¶
HTTP Request
POST /api/requestPriority
📋 Description: Submits a request to prioritize a specific task or project within the system, enabling efficient resource allocation and improved workflow management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the priority level and associated details for processing requests efficiently within the system. |
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 "requestPriorityType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get All Request Priority Type¶
HTTP Request
GET /api/requestPriority/requestPriorityType
📋 Description: Retrieves a list of available request priority types, enabling users to understand and categorize requests based on their urgency and importance.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "LOW"
3]