Engage API 사용

요청

요청 헤더

머리글	설명
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	응답 본문의 미디어 유형을 나타냅니다.

응답 본문

응답 본문에는 요청된 데이터가 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" } ] }

요청

요청 헤더

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

요청 본문

요청 본문은 세 가지 필수 속성이 있는 JSON 개체로 구성됩니다. FileName, ProjectTemplateName및 CreateFileType.

{ "파일 이름": "name of idea" "ProjectTemplateName":"프로젝트에 사용할 프로젝트 템플릿의 이름", 워크플로가 아닌 프로젝트에는 #Only. 이름은 구독의 프로젝트 템플릿과 일치해야 합니다. "CreateFileType": 0, #(0 아이디어, 1 비 워크플로우 프로젝트) }

다음 옵션 중 하나를 포함할 수 있습니다.

• OwnerEmail: 이 새 파일을 소유할 사용자의 이메일 주소입니다.
• IncludeInDashboard를 사용합니다. true 또는 false 값을 사용하여 구독 설정의 기본값을 재정의합니다.
• Data: 파일에서 데이터 필드 값을 설정하는 개체입니다. Data 필드 코드명 및 값의 개체에 매핑된 단일 값 범주 코드명으로 구성됩니다.
• TableData: 파일에서 테이블 데이터 값을 설정하는 개체입니다. TableData 는 필드, 코드명 및 값 집합의 개체에 매핑된 데이터, 테이블, 범주, 코드명으로 구성됩니다.
  • 아이디어의 경우 테이블 데이터는 아이디어 양식에 있어야 합니다.
  • 테이블 데이터에서 필드의 값 수가 같지 않으면 값이 더 적은 필드가 나머지 행의 기본값으로 설정됩니다.
  • null 을 사용하여 빈 값을 가져옵니다.
  • 일부 데이터 테이블에는 [teammember / name]과 같은 필수 필드가 있습니다. 필수 필드가 비어 있으면 프로젝트가 생성되지 않습니다.
• NotificationRecipientsCreate File 작업이 성공하거나 실패할 때 메시지를 받을 이메일 주소입니다.

{ "파일 이름": "아이디어 이름", "ProjectTemplateName":"그냥 하세요", "CreateFileType":1, "OwnerEmail":"user@company.com", "IncludeInDashboard":false, "NotificationRecipients": ["fmae@mortgage.gov", "user@domain.com"], "데이터": { "프로젝트 요약": { "belt_level": "그린벨트", "critical_to": "긴 텍스트\r\nwith\r\nnewlines" }, "annualized_financial": { "annualized_actual_hard_savings": 100 } } "TableData":{ "teammember":{ "name":["John Q. Public","Fannie Mae","Freddie Mac"], "role":["프로젝트 리더",null,"모기지 브로커"], "email":[null,"fmae@mortgage.gov"] }, "task":{ "subject":["재융자","출처"] "startdate":["2025-04-24"] } } }

참고

공유할 수 있는 유효한 데이터 필드 및 범주 이름 목록을 보려면 데이터 설계사가 의 Engage web app탭에서 CSV 파일을 설정 다운로드할 수 있습니다.

참고

팀 구성원의 이름을 팀 역할(스폰서, 챔피언, 재무 분석가등)로 설정하려면 팀 구성원/역할 필드를 역할 필드에 연결합니다. 이전 예에서는 Team Role / Project Leader 가 "John Q. Public"으로 설정됩니다.

참고

Create File 작업은 모든 필드에 대한 데이터 값 설정을 지원하지 않습니다. 수식, 서식 있는 텍스트 또는 내부 필드에 대한 데이터를 제공하려고 하면 오류가 발생합니다.

샘플 요청

Request: POST https://engage.minitab.com/api/v2/4906fcd496d94f738304dfcde754000a/Item HTTP/1.1 Headers: Authorization: Bearer token Content-Type: application/json Content-Length: 785 Body: { "FileName": "file name", "ProjectTemplateName":"DMAIC Project", "CreateFileType": 1, "OwnerEmail":"user@yourcompany.com", "IncludeInDaashboard":true, "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 } }, "TableData": { "_tableCategory1": { "_text_field": ["text value","text_value2","text_value"], "_date_field": ["2025-03-20","2025-04-21","2024-03-20"], "_number_field": [3.1415,2.73,1.414] }, "_tableCategory2": { "_text_field": ["text value",null,"text_3"], "_date_field": ["2025-03-20","2025-08-23"], "_number_field": [3.1415,null] } } }

반응

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

상태 코드

작업이 성공하면 상태 코드 202(수락됨)가 반환됩니다.

응답 헤더

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

머리글	설명
Location	작업 상태를 검색하는 데 사용할 수 있는 URL입니다.

응답 본문

작업에 대한 Create File 응답에는 프로젝트 또는 아이디어를 만들 작업의 식별자가 포함됩니다. 형식은 JSON 다음과 같습니다.

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

요청

요청 헤더

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

요청

요청 헤더

머리글	설명
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 응답에는 다음 예제와 같이 작업의 다양한 가능한 상태를 나타내는 integer 속성이 포함됩니다 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 }