Start progress
Relative path: /v3/incidents/{incidentUuid}:startProgress
Start progress on an incident. The status of the incident is changed to 'In Progress'. This action can only be performed for an incident with an assigned user in the assignee role.
Endpoint URL for Europe, Germany, United States, Canada and Japan regions:
|
https://eu.incident-management.eset.systems/v3/incidents/{incidentUuid}:startProgress |
|
https://de.incident-management.eset.systems/v3/incidents/{incidentUuid}:startProgress |
|
https://us.incident-management.eset.systems/v3/incidents/{incidentUuid}:startProgress |
|
https://ca.incident-management.eset.systems/v3/incidents/{incidentUuid}:startProgress |
|
https://jpn.incident-management.eset.systems/v3/incidents/{incidentUuid}:startProgress |
Request body
Type |
Required |
Example |
Schema |
|---|---|---|---|
application/json |
Yes |
{
"assigneeUuid": "string"
} |
{
"$ref": "IncidentsStartIncidentProgressBody",
"assigneeUuid": {
"type": "string",
"description": "Reference to the User to be assigned as the assignee. It should either be pre-set in the incident or be included in the request to transition to the 'In Progress' status. type: user_management.v1.User"
}
} |
Parameters in path
Name |
Type |
Required |
Description |
|---|---|---|---|
incidentUuid |
string |
Yes |
Reference to the [Incident]. type: Incident |
Responses
Code |
Description and Example |
Description, Schema and Headers |
|---|---|---|
200 |
Successful response. |
Successful response.
{
"$ref": "v3StartIncidentProgressResponse",
"title": "empty",
"type": "object"
}
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
Response took too long; request cached. Response can be retrieved later using the response-id header.
[]
{
"response-id": {
"description": "Unique ID of a pending request. Used to retrieve cached result.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
401 |
Token has expired or is invalid. |
Token has expired or is invalid.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
403 |
Access denied. Check permissions. |
Access denied. Check permissions.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
404 |
Requested resource not found. |
Requested resource not found.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
429 |
Rate limit reached. Try again later. |
Rate limit reached. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
500 |
Internal server failure. Try again later. |
Internal server failure. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
502 |
Internal server failure. Try again later. |
Internal server failure. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
503 |
Environment under maintenance. Try again later. |
Environment under maintenance. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
504 |
Action took too long; timeout reached |
Action took too long; timeout reached
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|