Sla Management Resource¶
Update Status¶
HTTP Request
PUT /api/slaManagement/{workOrderId}/status/{statusId}
📋 Description: Updates the status of a specified work order within the SLA management system, allowing for real-time adjustments to service level agreements as business needs evolve.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
workOrderId |
path |
integer(int64) |
true |
Unique identifier for the work order |
statusId |
path |
integer(int64) |
true |
Unique identifier for the status |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Update¶
HTTP Request
PUT /api/slaManagement/{workOrderId}/startTime
📋 Description: Updates the start time for a specified work order, enabling effective tracking and management of service level agreements (SLAs) within the operational workflow.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
workOrderId |
path |
integer(int64) |
true |
Unique identifier for the work order |
body |
body |
true |
Request body containing the updated start time for the specified work order, ensuring accurate tracking of service level agreements. |
Body Parameters
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "startTime": "2019-08-24T14:15:22Z",
8 "endTime": "2019-08-24T14:15:22Z",
9 "firstNotification": true,
10 "secondNotification": true,
11 "timeType": "string",
12 "workOrderId": 0
13 }
14]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Get Sla Management By Work Order ID¶
HTTP Request
GET /api/slaManagement/workOrder/{workOrderId}
📋 Description: Fetches detailed information about a specific work order identified by the provided workOrderId, enabling users to monitor and manage service level agreements effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
workOrderId |
path |
integer(int64) |
true |
Unique identifier for the work order |
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 "startTime": "2019-08-24T14:15:22Z",
8 "endTime": "2019-08-24T14:15:22Z",
9 "firstNotification": true,
10 "secondNotification": true,
11 "timeType": "string",
12 "workOrderId": 0
13 }
14]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[SlaManagementDto is a data transfer object that encapsulates the details of Service Level Agreements (SLAs), including performance metrics and compliance status, essential for effective service management and operational oversight.] |
|
» 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 |
» startTime |
string(date-time) |
false |
none |
Time of the start |
» endTime |
string(date-time) |
false |
none |
Time of the end |
» firstNotification |
boolean |
false |
none |
Indicates whether this is the first notification related to the SLA management process. |
» secondNotification |
boolean |
false |
none |
Indicates whether a second notification should be triggered within the SLA management process. |
» timeType |
string |
false |
none |
Type of the time |
» workOrderId |
integer(int64) |
false |
none |
Unique identifier for the work order |