查询工单 - OncallBox-OpenAPI文档

请求参数

Authorization

API Key

在 header 添加参数

X-Client-Key

示例：

X-Client-Key: ********************

API Key

在 header 添加参数

X-Timestamp

示例：

X-Timestamp: ********************

API Key

在 header 添加参数

X-Sign

示例：

X-Sign: ********************

or

Body 参数application/json必填

示例

{
    "page": 1,
    "size": 20,
    "status": "Triggered",
    "order_by": "create_at desc"
}

请求示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/incident/query' \
--header 'X-Client-Key: <api-key>' \
--header 'X-Timestamp: <api-key>' \
--header 'X-Sign: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 1,
    "size": 20,
    "status": "Triggered",
    "order_by": "create_at desc"
}'

返回响应

🟢200

application/json

查询成功

Body

示例

{
    "code": 0,
    "msg": "OK",
    "data": {
        "incidents": [
            {
                "incident_id": "string",
                "status": "string",
                "title": "string",
                "detail": "string",
                "severity": "string",
                "create_by": "string",
                "create_at": 0,
                "service_id": "string",
                "assign_by": "string",
                "is_close": true,
                "close_description": "string",
                "is_suspend": true,
                "source": "string",
                "resolve_by": "string",
                "resolve_at": 0,
                "ack_at": 0,
                "ack_by": "string",
                "merge_type": "string",
                "escalation_id": "string",
                "follow_by": "string",
                "chat_group": {
                    "chat_group_id": "string",
                    "members": [
                        "string"
                    ],
                    "description": "string"
                },
                "assign_description": "string",
                "assign_type": "string",
                "ack_duration": 0,
                "resolve_duration": 0
            }
        ],
        "count": {
            "total": 0,
            "open": 0,
            "triggered": 0,
            "ack": 0,
            "resolved": 0,
            "closed": 0
        }
    }
}

🟠401UnauthorizedResponse