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 Engage.

Neste tópico

Extremidade

No momento, a Engage API oferece suporte aos seguintes pontos de extremidade.
Operação Descrição
Ler dados do painel 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.
Criar ideia Cria uma nova ideia de projeto.
Obter status do trabalho Obtém as informações de status de um trabalho em segundo plano especificado.

Ler dados do painel

A operação Read Dashboard Data 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 padrão OData para consultar dados.

Não há suporte para as seguintes funções OData:
  • $filter
  • $apply
  • $orderby
  • $select
  • $expand
  • $count
  • $skip
  • $top

Pedir

A solicitação Read Dashboard Data pode ser construída da seguinte maneira. 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 autorização Bearer.
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 código de status HTTP, 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 HTTP padrão adicionais. Todos os cabeçalhos padrão estão em conformidade com a 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 no formato JSON, estruturados de acordo com o padrão OData. 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 ideia

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

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 autorização Bearer . O token é necessário para ter a permissão Create Idea .
Content-Type Necessário. Deve ser application/json.
Corpo da solicitação
O corpo da solicitação consiste em um objeto JSON com uma propriedade necessária FileName.
{
    "FileName": "name of idea"
}
Opcionalmente, você pode incluir um objeto Data 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 operação Create Idea. 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 código de status HTTP, 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 HTTP padrão 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 para a operação Create Idea contém o identificador do trabalho que criará a ideia do projeto. O formato JSON é 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 operação Get Job Status 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 autorização Bearer .
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 status HTTP 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 operação Get Job Status contém uma propriedade inteira Status 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.