Request Status Resource¶
Get Request Status¶
HTTP Request
GET /api/requestStatuses/{id}
📋 Description: Retrieves the status details of a specific request identified by the provided ID, enabling users to monitor and manage request progress effectively.
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 "requestStatusType": "string",
10 "isDefaultType": true
11}
Update Request Status¶
HTTP Request
PUT /api/requestStatuses/{id}
📋 Description: Updates the status of a specific request identified by its unique ID, allowing for the management and tracking of request progress within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated status information and relevant metadata for the specified request identified by the provided 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 "requestStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Request Status¶
HTTP Request
DELETE /api/requestStatuses/{id}
📋 Description: Deletes a specific request status identified by the provided ID, ensuring the removal of outdated or unnecessary entries 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 Request Statuses¶
HTTP Request
GET /api/requestStatuses
📋 Description: Retrieves the current statuses of requests, providing users with an overview of ongoing processes and their respective states for effective management and decision-making.
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 "requestStatusType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the status of a request within the system, including relevant metadata to facilitate tracking and management of request 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 requested object is available for processing within the system. |
» requestStatusType |
string |
false |
none |
Type of the request status |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Request Status¶
HTTP Request
POST /api/requestStatuses
📋 Description: Submits a new request status to the system, enabling the tracking and management of request progress within the workflow.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the status update data for tracking operational requests, including relevant identifiers and current state information. |
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 "requestStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get All Request Status Type¶
HTTP Request
GET /api/requestStatuses/requestStatusType
📋 Description: Retrieves the available request status types, providing essential information for tracking and managing request workflows within the system.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "OPEN"
3]