Engage API 사용

끝점

API는 Engage 현재 다음 엔드포인트를 지원합니다.

수술	설명
대시보드 데이터 읽기	대시보드 보고서 및 모든 워크플로 아이디어에 포함된 모든 프로젝트에서 전역 데이터 값을 가져옵니다.
아이디어 창출	새 프로젝트 아이디어를 만듭니다.
작업 상태 가져오기	지정된 백그라운드 작업에 대한 상태 정보를 가져옵니다.

대시보드 데이터 읽기

Read Dashboard Data 작업은 대시보드 보고서에 포함된 모든 프로젝트와 모든 워크플로우 아이디어에 대한 글로벌 프로젝트 데이터를 검색합니다. 이 엔드포인트는 OData 표준을 사용하여 데이터를 쿼리합니다.

지원되지 않는 OData 함수는 다음과 같습니다.

$filter
$apply
$orderby
$select
$expand
$count
$skip
$top

요청

Read Dashboard Data 요청은 다음과 같이 생성할 수 있습니다. subscription-id 를 구독의 ID로 바꿉니다.

방법	요청 URL
GET	`https://engage.minitab.com/api/v1/subscription-id/export/odata`

요청 헤더

머리글	설명
`Authorization`	필수. `Bearer` 권한 부여 체계를 통해 API 토큰을 제공합니다.

샘플 요청

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

Headers: Authorization: Bearer token

반응

응답에는 HTTP 상태 코드, 응답 헤더 집합 및 본문이 포함됩니다.

상태 코드

요청이 성공하면 상태 코드 200(정상)이 반환됩니다.

응답 헤더

이 작업에 대한 응답에는 다음 헤더가 포함됩니다. 응답에는 추가 표준 HTTP 헤더가 포함될 수도 있습니다. 모든 표준 헤더는 HTTP/1.1 프로토콜 사양을준수합니다.

머리글	설명
`Content-Type`	응답 본문의 미디어 유형을 나타냅니다.

응답 본문

응답 본문에는 OData 표준에 따라 구조화된 JSON 형식의 요청된 데이터가 포함됩니다. 다음은 응답의 예입니다.

{
    "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"
        }
    ]
}

아이디어 창출

Create Idea 작업은 구독에서 프로젝트 아이디어를 만드는 작업을 시작합니다.

요청

다음과 같이 Create Idea 요청을 생성할 수 있습니다. subscription-id 를 구독의 ID로 바꿉니다.

방법	요청 URL
`POST`	`https://engage.minitab.com/api/v1/subscription-id/Item`

요청 헤더

머리글	설명
`Authorization`	필수. `Bearer` 권한 부여 체계를 통해 API 토큰을 제공합니다. 토큰은 `Create Idea` 권한이 있어야 합니다.
`Content-Type`	필수. `application/json`이어야 합니다.

요청 본문

요청 본문은 하나의 필수 속성 FileName이 있는 JSON 개체로 구성됩니다.

{
    "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탭에서 CSV 파일을 설정 다운로드할 수 있습니다.

참고

아이디어 양식의 컨트롤에 공유되는 데이터 필드만 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(수락됨)가 반환됩니다.

응답 헤더

이 작업에 대한 응답에는 다음 헤더가 포함됩니다. 응답에는 추가 표준 HTTP 헤더가 포함될 수도 있습니다. 모든 표준 헤더는 HTTP/1.1 프로토콜 사양을준수합니다.

머리글	설명
`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"
}

작업 상태 가져오기

Get Job Status 작업은 지정된 작업의 상태를 검색합니다.

요청

다음과 같이 Get Job Status 요청을 생성할 수 있습니다. subscription-id 를 구독의 ID로 바꾸고 job-id 를 유효한 작업 식별자로 바꿉니다.

방법	요청 URL
`GET`	`https://engage.minitab.com/api/v1/subscription-id/job/job-id`

요청 헤더

머리글	설명
`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(정상)이 반환됩니다.

응답 본문

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
}

이 항목의 내용

끝점

대시보드 데이터 읽기

요청

반응

아이디어 창출

요청

참고

참고

반응

작업 상태 가져오기

요청

반응