Engage 使用 API

请求

请求标头

Header	说明
Authorization	必填。通过 Bearer 授权方案提供 API 令牌。

示例请求

Request: GET 
https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/export/odata 
HTTP/1.1

Headers: Authorization: Bearer token

响应

响应包括一个 HTTP 状态代码、一组响应标头和一个正文。

状态代码

成功的请求将返回状态代码 200 （OK）。

响应标头

此作的响应包括以下标头。响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

Header	说明
Content-Type	指示响应正文的媒体类型。

响应正文

响应正文包含 JSON 格式的请求数据，根据 OData 标准进行结构化。下面是响应的示例：

{
    "value": [
        {
            "ProjectId": "12345",
            "ProjectName": "Project A",
            "Status": "Active",
            "StartDate": "2025-01-01",
            "EndDate": "2025-12-31"
        },
        {
            "ProjectId": "67890",
            "ProjectName": "Project B",
            "Status": "Completed",
            "StartDate": "2024-01-01",
            "EndDate": "2024-12-31"
        }
    ]
}

示例响应

Response Status:
HTTP/1.1 200 OK

Response headers:
Content-Type: application/json

Response Body:
{
    "value": [
        {
            "ProjectId": "12345",
            "ProjectName": "Project A",
            "Status": "Active",
            "StartDate": "2025-01-01",
            "EndDate": "2025-12-31"
        },
        {
            "ProjectId": "67890",
            "ProjectName": "Project B",
            "Status": "Completed",
            "StartDate": "2024-01-01",
            "EndDate": "2024-12-31"
        }
    ]
}

请求

请求标头

Header	说明
Authorization	必填。通过 Bearer 授权方案提供 API 令牌。令牌需要具有 Create Idea 权限。
Content-Type	必填。必须是 application/json。

请求正文

请求正文由一个 JSON 对象和一个必需属性 FileName组成。

{
    "FileName": "name of idea"
}

您可以选择包括一个 Data 对象，以便在概念中设置数据字段值。数据由映射到字段代号和值的对象的单值类别代号组成。

{
    "FileName": "name of idea",
    "Data": {
        "projectsummary": {
            "belt_level": "Green Belt",
            "critical_to": "Long text\r\nwith\r\nnewlines"
        },
        "annualized_financial": {
            "annualized_actual_hard_savings": 100
        }
    }
}

注意

要查看可用于共享的有效数据字段和类别名称的列表，数据架构师可以从 设置 Engage web app.

注意

只有在 Create Idea 作请求中才能指定共享给概念表单上的控件的数据字段。此外，不支持指定富文本、公式、只读或数据表字段。尝试为未共享到概念表单上的控件的字段或富文本、公式、只读或数据表字段提供数据将导致错误。

样品请求

Request:
POST https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/Item HTTP/1.1

Headers:
Authorization: Bearer token
Content-Type: application/json
Content-Length: 287

Body:
{
    "FileName": "idea name",
    "Data": {
        "_category1": {
            "_text_field": "text value",
            "_date_field": "2025-03-20",
            "_number_field": 3.1415
        },
        "_category2": {
            "_text_field": "text value",
            "_date_field": "2025-03-20",
            "_number_field": 3.1415     
        }
    }   
}

响应

响应包括一个 HTTP 状态代码、一组响应标头和一个正文。

状态代码

成功的作将返回状态代码 202 （Accepted）。

响应标头

此作的响应包括以下标头。响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

Header	说明
Location	可用于检索作业状态的 URL。

响应正文

Create Idea 作的响应包含将创建项目概念的作业的标识符。JSON 格式如下所示：

{
    "JobId": "479f6bea-360f-40ba-be0a-bd06c032c4fb"
}

示例响应

Response Status:
HTTP/1.1 202 ACCEPTED

Response headers:
Location: /api/v1/4906fcd496d94f738304dfcde754000a/job/479f6bea-360f-40ba-be0a-bd06c032c4fb
Content-Type: application/json

Response Body:
{
    "JobId": "479f6bea-360f-40ba-be0a-bd06c032c4fb"
}

请求

请求标头

Header	说明
Authorization	必填。通过 Bearer 授权方案提供 API 令牌。

示例请求

Request:
GET https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/job/479f6bea-360f-40ba-be0a-bd06c032c4fb HTTP/1.1

Headers:
Authorization: Bearer token

响应

响应包括 HTTP 状态代码和正文。

状态代码

成功的请求将返回状态代码 200 （OK）。

响应正文

Get Job Status 作的响应包含一个 Status 整数属性，该属性表示作业的各种可能状态，如以下示例所示。

{
    "Status": 1
} 

作业状态	说明
0	作业尚未开始
1	作业已启动;进行中
2	作业已完成
3	作业已失败
4	找不到作业
5	作业已取消

示例响应

Response Status:
HTTP/1.1 200 OK

Response headers:
Content-Type: application/json

Response Body:
{
    "Status": 2
}