Update Troubleshooting Incident

Updates Guided Network Troubleshooting incident

Request

URI

PUT

https://{api_host}/api/ni/gnt/troubleshoot/incidents/{id}

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Request Body

UpdateTroubleshootingIncidentRequest of type(s) application/json

Optional

{
    "name": "string",
    "start_time": 0,
    "end_time": 0,
    "status": "string"
}

string

name

Optional

name

integer As int64 As int64

start_time

Optional

start_time

integer As int64 As int64

end_time

Optional

end_time

string

status

Optional

status

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

OpsTokenAuth

Responses

200

Returns TroubleshootingIncidentResponse of type(s) application/json

{
    "entity_id": "string",
    "start_entity_id": "string",
    "name": "string",
    "status": "string",
    "created_time": 0,
    "start_time": 0,
    "end_time": 0,
    "last_modified_time": 0,
    "created_by": "string",
    "last_modified_by": "string"
}

string

entity_id

Optional

entity_id

string

start_entity_id

Optional

start_entity_id

string

name

Optional

name

string

status

Optional

status

integer As int64 As int64

created_time

Optional

created_time

integer As int64 As int64

start_time

Optional

start_time

integer As int64 As int64

end_time

Optional

end_time

integer As int64 As int64

last_modified_time

Optional

last_modified_time

string

created_by

Optional

created_by

string

last_modified_by

Optional

last_modified_by

400

Bad Request

Returns BadRequestResponse of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

401

Unauthorized

Returns UnauthorizedResponse of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

403

Forbidden

Returns ForbiddenResponse of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

404

Not Found

Returns NotFoundResponse of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

500

Internal error

Returns InternalErrorResponse of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/gnt/troubleshoot/incidents/{id}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Guided Network Troubleshooting Operations

GET

List Troubleshooting Incidents