Soporte de Minitab Engage® 

Usar la Engage API

Más información sobre Minitab Engage
Utilice la Engage API para enviar y extraer datos hacia y desde Engage.

En este tema

Extremos

Actualmente, la Engage API admite los siguientes puntos de conexión.
Operación Descripción
Leer los datos del panel Obtiene valores de datos globales de todos los proyectos incluidos en los informes del panel y todas las ideas de flujo de trabajo.
Crear idea Crea una nueva idea de proyecto.
Obtener el estado del trabajo Obtiene la información de estado de un trabajo en segundo plano especificado.

Leer los datos del panel

La operación Read Dashboard Data recupera datos globales del proyecto para todos los proyectos incluidos en los informes del panel y todas las ideas de flujo de trabajo. Este punto de conexión usa el estándar OData para consultar datos.

No se admiten las siguientes funciones de OData:
  • $filter
  • $apply
  • $orderby
  • $select
  • $expand
  • $count
  • $skip
  • $top

Pedir

La solicitud de Read Dashboard Data se puede construir de la siguiente manera. Reemplace subscription-id por el identificador de su suscripción.
Método URL de solicitud
GET https://engage.minitab.com/api/v1/subscription-id/export/odata
Encabezados de solicitud
Header Descripción
Authorization Obligatorio. Proporcione un token de API a través del esquema de autorización del Bearer .
Solicitud de muestra
Request: GET 
https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/export/odata 
HTTP/1.1

Headers: Authorization: Bearer token

Respuesta

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo.

Código de estado
Una solicitud correcta devuelve el código de estado 200 (OK).
Encabezados de respuesta
La respuesta para esta operación incluye los siguientes encabezados. La respuesta también puede incluir encabezados HTTP estándar adicionales. Todos los encabezados estándar cumplen con la especificación del protocolo HTTP/1.1.
Header Descripción
Content-Type Indica el tipo de medio del cuerpo de la respuesta.
Cuerpo de respuesta
El cuerpo de la respuesta contiene los datos solicitados en formato JSON, estructurados según el estándar OData. A continuación se muestra un ejemplo de la respuesta:
{
    "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"
        }
    ]
}
Ejemplo de respuesta
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"
        }
    ]
}

Crear idea

La operación Create Idea inicia un trabajo para crear una idea de proyecto en la suscripción.

Pedir

Puede crear la solicitud Create Idea como se muestra aquí. Reemplace subscription-id por el identificador de su suscripción.
Método URL de solicitud
POST https://engage.minitab.com/api/v1/subscription-id/Item
Encabezados de solicitud
Header Descripción
Authorization Obligatorio. Proporcione un token de API a través del esquema de autorización del Bearer . El token debe tener el permiso Create Idea .
Content-Type Obligatorio. Debe ser application/json.
Cuerpo de la solicitud
El cuerpo de la solicitud consta de un objeto JSON con una propiedad obligatoria FileName.
{
    "FileName": "name of idea"
}
Opcionalmente, puede incluir un objeto Data para establecer los valores de los campos de datos en la idea. Los datos constan de nombres de código de categoría de un solo valor asignados a objetos de nombres de código y 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
        }
    }
}
Nota

Para ver la lista de campos de datos válidos y nombres de categorías disponibles para compartir, los arquitectos de datos pueden descargar un archivo CSV desde la pestaña Einstellungen de la Engage web app.

Nota

Solo los campos de datos que se comparten con los controles del formulario de idea se pueden especificar en la solicitud de operación Create Idea. Además, no se admite la especificación de campos de texto enriquecido, fórmula, solo lectura o tabla de datos. Si se intenta proporcionar datos para los campos no compartidos con los controles de los campos de formulario de idea o texto enriquecido, fórmula, solo lectura o tabla de datos, se producirá un error.

Solicitud de muestra
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     
        }
    }   
}

Respuesta

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo.

Código de estado
Una operación correcta devuelve el código de estado 202 (Aceptado).
Encabezados de respuesta
La respuesta para esta operación incluye los siguientes encabezados. La respuesta también puede incluir encabezados HTTP estándar adicionales. Todos los encabezados estándar cumplen con la especificación del protocolo HTTP/1.1.
Header Descripción
Location Una dirección URL que se puede utilizar para recuperar el estado del trabajo.
Cuerpo de respuesta
La respuesta de la operación Create Idea contiene el identificador del trabajo que creará la idea del proyecto. El formato JSON se muestra a continuación:
{
    "JobId": "479f6bea-360f-40ba-be0a-bd06c032c4fb"
}
Ejemplo de respuesta
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"
}

Obtener el estado del trabajo

La operación Get Job Status recupera el estado del trabajo especificado.

Pedir

La solicitud Get Job Status se puede construir de la siguiente manera. Reemplace subscription-id por el ID de su suscripción y job-id por un identificador de trabajo válido.
Método URL de solicitud
GET https://engage.minitab.com/api/v1/subscription-id/job/job-id
Encabezados de solicitud
Header Descripción
Authorization Obligatorio. Proporcione un token de API a través del esquema de autorización del Bearer .
Solicitud de muestra
Request:
GET https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/job/479f6bea-360f-40ba-be0a-bd06c032c4fb HTTP/1.1

Headers:
Authorization: Bearer token

Respuesta

La respuesta incluye un código de estado HTTP y un cuerpo.

Código de estado
Una solicitud correcta devuelve el código de estado 200 (OK).
Cuerpo de respuesta
La respuesta de la operación Get Job Status contiene una propiedad entera Status que representa los distintos estados posibles de un trabajo, como se muestra en el ejemplo siguiente.
{
    "Status": 1
}
Estado del trabajo Descripción
0 El trabajo aún no ha comenzado
1 El trabajo ha comenzado; en curso
2 El trabajo se ha completado
3 El trabajo ha fallado
4 No se pudo encontrar el trabajo
5 El trabajo se ha cancelado
Ejemplo de respuesta
Response Status:
HTTP/1.1 200 OK

Response headers:
Content-Type: application/json

Response Body:
{
    "Status": 2
}
Copyright © 2025 Minitab, LLC. All rights Reserved.