Suporte ao Minitab Engage® 

Usar a Engage API

Saiba mais sobre Minitab Engage
Use a Engage API para enviar e extrair dados de e para o Engage.

Neste tópico

Extremidade

No momento, a Engage API oferece suporte aos seguintes pontos de extremidade.
Operação Descrição
Read Dashboard Data Obtém valores de dados globais de todos os projetos incluídos nos relatórios do painel e todas as ideias de fluxo de trabalho.
Create File Cria uma nova ideia de projeto ou um projeto que não seja de fluxo de trabalho.
Observação

Recomendado sobre Create Idea.
Create Idea Cria uma nova ideia de projeto.
Observação

Para funcionalidade estendida, use Create File.
Get Job Status Obtém as informações de status de um trabalho em segundo plano especificado.

Ler dados do painel

A Read Dashboard Data operação recupera dados globais do projeto para todos os projetos incluídos nos relatórios do painel e todas as ideias de fluxo de trabalho. Esse ponto de extremidade usa o OData padrão para consultar dados.

As seguintes OData funções não são suportadas:
  • $filter
  • $apply
  • $orderby
  • $select
  • $expand
  • $count
  • $skip
  • $top

Pedir

A Read Dashboard Data solicitação pode ser construída da seguinte forma. Substitua subscription-id pela ID da sua assinatura.
Método URL da solicitação
GET https://engage.minitab.com/api/v1/subscription-id/export/odata
Cabeçalhos de solicitação
Cabeçalho Descrição
Authorization Necessário. Forneça um token de API por meio do esquema de Bearer autorização.
Solicitação de amostra
Request: GET https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/export/odata HTTP/1.1 Headers: Authorization: Bearer token

Resposta

A resposta inclui um HTTP código de status, um conjunto de cabeçalhos de resposta e um corpo.

Código de status
Uma solicitação bem-sucedida retorna o código de status 200 (OK).
Cabeçalhos de resposta
A resposta para essa operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com o especificação do protocolo HTTP/1.1.
Cabeçalho Descrição
Content-Type Indica o tipo de mídia do corpo da resposta.
Corpo da resposta
O corpo da resposta contém os dados solicitados em JSON formato, estruturados de acordo com o OData padrão. Abaixo está um exemplo da resposta: 
{ "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" } ] }
Exemplo de resposta
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" } ] }

Criar arquivo

A operação Create File inicia um trabalho para criar uma nova ideia de projeto ou um projeto que não seja de fluxo de trabalho em sua assinatura.

Pedir

Você pode construir a solicitação Criar Arquivo conforme mostrado aqui. Substitua subscription-id pela ID da sua assinatura.
Método URL da solicitação
POST https://engage.minitab.com/api/v2/subscription-id/Item
Cabeçalhos de solicitação
Cabeçalho Descrição
Authorization Necessário. Forneça um token de API por meio do esquema de autorização Bearer . O token é necessário para ter a Create Idea permissão.
Content-Type Necessário. Deve ser application/json.
Corpo da solicitação
O corpo da solicitação consiste em um objeto JSON com três propriedades necessárias: FileName, ProjectTemplateName e CreateFileType.
{ "Nome do arquivo": "nome da ideia" "ProjectTemplateName":"nome do modelo de projeto a ser usado para o projeto", #Only necessário para projetos sem fluxo de trabalho. O nome deve corresponder a um modelo de projeto em sua assinatura. "CreateFileType": 0, #(0 Ideia, 1 Projeto sem Fluxo de Trabalho) }
Você pode incluir qualquer uma das opções a seguir.
  • OwnerEmail: O endereço de e-mail do usuário que será o proprietário desse novo arquivo.
  • IncludeInDashboard: Um valor verdadeiro ou falso para substituir o valor padrão nas configurações de assinatura.
  • Data: O objeto para definir valores de campo de dados no arquivo. Data consistem em codinomes de categoria de valor único mapeados para objetos de codinomes e valores de campo.
  • TableData: O objeto para definir os valores de dados da tabela no arquivo. TableData consiste em codinomes de categoria de tabela de dados mapeados para objetos de codinomes de campo e conjuntos de valores.
    • Para ideias, os dados da tabela devem estar no formulário de ideias.
    • Nos dados da tabela, quando o número de valores de um campo é desigual, os campos com menos valores são definidos como seus valores padrão nas linhas restantes.
    • Use null para obter um valor em branco.
    • Algumas tabelas de dados têm campos obrigatórios, como [teammember / name]. Quando os campos obrigatórios estão vazios, um projeto não é criado.
  • NotificationRecipients: Endereços de email para receber uma mensagem quando a operação Create File for bem-sucedida ou falhar.
{ "Nome do arquivo": "nome da ideia", "ProjectTemplateName":"Just Do It", "CreateFileType":1, "OwnerEmail":"user@company.com", "IncludeInDashboard":false, "NotificationRecipients": ["fmae@mortgage.gov", "user@domain.com"], "Dados": { "resumo do projeto": { "belt_level": "Cinturão Verde", "critical_to": "Texto longo\r\ncom\r\nnovas linhas" }, "annualized_financial": { "annualized_actual_hard_savings": 100 } } "TableData":{ "membro da equipe":{ "name":["John Q. Public","Fannie Mae","Freddie Mac"], "role":["Líder do projeto",null,"Mortgage Broker"], "email":[null,"fmae@mortgage.gov"] }, "task":{ "subject":["refinance","origination"] "startdate":["2025-04-24"] } } }
Observação

Para ver a lista de campos de dados válidos e nomes de categorias disponíveis para compartilhamento, os arquitetos de dados podem baixar um arquivo CSV na Configurações guia do Engage web app.

Observação

Para definir o nome de um membro da equipe para uma função de equipe (Patrocinador, Campeão, Analista Financeiro, etc.), conecte o campo Membro da Equipe / Função ao campo Função . No exemplo anterior, a Team Role / Project Leader será definida como "John Q. Público".

Observação

A operação Create File não dá suporte à configuração de valores de dados para todos os campos. A tentativa de fornecer dados para fórmula, rich text ou campos internos resultará em um erro.

Solicitação de amostra
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] } } }

Resposta

A resposta inclui um HTTP código de status, um conjunto de cabeçalhos de resposta e um corpo.

Código de status
Uma operação bem-sucedida retorna o código de status 202 (Aceito).
Cabeçalhos de resposta
A resposta para essa operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.
Cabeçalho Descrição
Location Uma URL que pode ser usada para recuperar o status do trabalho.
Corpo da resposta
A resposta da Create File operação contém o identificador do trabalho que criará o projeto ou a ideia. O JSON formato é mostrado abaixo: 
{ "JobId": "479f6bea-360f-40ba-be0a-bd06c032c4fb" }

Criar ideia

A Create Idea operação inicia um trabalho para criar uma ideia de projeto em sua assinatura.
Observação

Ao criar uma nova ideia de projeto, você pode usar Create Idea, mas Create File é recomendado.

Pedir

Você pode construir a solicitação Create Idea conforme mostrado aqui. Substitua subscription-id pela ID da sua assinatura.
Método URL da solicitação
POST https://engage.minitab.com/api/v1/subscription-id/Item
Cabeçalhos de solicitação
Cabeçalho Descrição
Authorization Necessário. Forneça um token de API por meio do esquema de Bearer autorização. O token é necessário para ter a Create Idea permissão.
Content-Type Necessário. Deve ser application/json.
Corpo da solicitação
O corpo da solicitação consiste em um JSON objeto com uma propriedade FileNamenecessária.
{ "FileName": "name of idea" }
Opcionalmente, você pode incluir um Data objeto para definir valores de campo de dados na ideia. Os dados consistem em codinomes de categoria de valor único mapeados para objetos de codinomes e valores de campo. 
{ "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 } } }
Observação

Para ver a lista de campos de dados válidos e nomes de categorias disponíveis para compartilhamento, os arquitetos de dados podem baixar um arquivo CSV na Configurações guia do Engage web app.

Observação

Somente os campos de dados compartilhados com controles no formulário de ideia podem ser especificados na solicitação de Create Idea operação. Além disso, não há suporte para a especificação de campos rich text, fórmula, somente leitura ou tabela de dados. A tentativa de fornecer dados para campos não compartilhados com controles no formulário de ideia ou nos campos rich text, fórmula, somente leitura ou tabela de dados resultará em um erro.

Solicitação de amostra
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 } } }

Resposta

A resposta inclui um HTTP código de status, um conjunto de cabeçalhos de resposta e um corpo.

Código de status
Uma operação bem-sucedida retorna o código de status 202 (Aceito).
Cabeçalhos de resposta
A resposta para essa operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.
Cabeçalho Descrição
Location Uma URL que pode ser usada para recuperar o status do trabalho.
Corpo da resposta
A resposta da Create Idea operação contém o identificador do trabalho que criará a ideia do projeto. O JSON formato é mostrado abaixo: 
{ "JobId": "479f6bea-360f-40ba-be0a-bd06c032c4fb" }
Exemplo de resposta
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" }

Obter status do trabalho

A Get Job Status operação recupera o status do trabalho especificado.

Pedir

A solicitação Get Job Status pode ser construída da seguinte maneira. Substitua subscription-id pela ID da sua assinatura e job-id por um identificador de trabalho válido.
Método URL da solicitação
GET https://engage.minitab.com/api/v1/subscription-id/job/job-id
Cabeçalhos de solicitação
Cabeçalho Descrição
Authorization Necessário. Forneça um token de API por meio do esquema de Bearer autorização.
Solicitação de amostra
Request: GET https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/job/479f6bea-360f-40ba-be0a-bd06c032c4fb HTTP/1.1 Headers: Authorization: Bearer token

Resposta

A resposta inclui um código de HTTP status e um corpo.

Código de status
Uma solicitação bem-sucedida retorna o código de status 200 (OK).
Corpo da resposta
A resposta para a Get Job Status operação contém uma Status propriedade inteira que representa os vários estados possíveis de um trabalho, conforme mostrado no exemplo a seguir.
{ "Status": 1 }
Status do trabalho Descrição
0 Trabalho ainda não iniciado
1 Jó começou; em andamento
2 Trabalho concluído
3 O trabalho falhou
4 Não foi possível encontrar emprego
5 Trabalho foi cancelado
Exemplo de resposta
Response Status: HTTP/1.1 200 OK Response headers: Content-Type: application/json Response Body: { "Status": 2 }
Copyright © 2025 Minitab, LLC. All rights Reserved.