Support für Minitab Engage® 

Verwenden der Engage API

Weitere Informationen zu Minitab Engage
Verwenden Sie die Engage API, um Daten von und zu senden und abzurufen Engage.

In diesem Thema

Endpunkte

Die Engage API unterstützt derzeit die folgenden Endpunkte.
Betrieb Beschreibung
Lesen von Dashboard-Daten Ruft globale Datenwerte aus allen Projekten ab, die in Dashboard-Berichten enthalten sind, und aus allen Workflow-Ideen.
Idee erstellen Erstellt eine neue Projektidee.
Abrufen des Auftragsstatus Ruft die Statusinformationen für einen angegebenen Hintergrundauftrag ab.

Lesen von Dashboard-Daten

Der Vorgang Read Dashboard Data ruft globale Projektdaten für alle Projekte ab, die in Dashboard-Berichten enthalten sind, und für alle Workflow-Ideen. Dieser Endpunkt verwendet den OData-Standard zum Abfragen von Daten.

Die folgenden OData-Funktionen werden nicht unterstützt:
  • $filter
  • $apply
  • $orderby
  • $select
  • $expand
  • $count
  • $skip
  • $top

Bitten

Die Anforderung Read Dashboard Data kann wie folgt aufgebaut werden. Ersetzen Sie subscription-id durch die ID Ihres Abonnements.
Methode URL anfordern
GET https://engage.minitab.com/api/v1/subscription-id/export/odata
Header anfordern
Kopfzeile Beschreibung
Authorization Erforderlich. Stellen Sie ein API-Token Bearer über das Bearer-Autorisierungsschema bereit.
Muster-Anfrage
Request: GET 
https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/export/odata 
HTTP/1.1

Headers: Authorization: Bearer token

Antwort

Die Antwort enthält einen HTTP-Statuscode, eine Reihe von Antwortheadern und einen Text.

Statuscode
Eine erfolgreiche Anforderung gibt den Statuscode 200 (OK) zurück.
Antwort-Header
Die Antwort für diesen Vorgang enthält die folgenden Header. Die Antwort kann auch zusätzliche standardmäßige HTTP-Header enthalten. Alle Standard-Header entsprechen der HTTP/1.1-Protokollspezifikation.
Kopfzeile Beschreibung
Content-Type Gibt den Medientyp des Antworttexts an.
Antwort-Text
Der Antworttext enthält die angeforderten Daten im JSON-Format, strukturiert nach dem OData-Standard. Nachfolgend finden Sie ein Beispiel für die Antwort:
{
    "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"
        }
    ]
}
Beispiel für eine Antwort
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"
        }
    ]
}

Idee erstellen

Der Vorgang Create Idea initiiert einen Auftrag, um eine Projektidee in Ihrem Abonnement zu erstellen.

Bitten

Sie können die Anforderung Create Idea wie hier gezeigt erstellen. Ersetzen Sie subscription-id durch die ID Ihres Abonnements.
Methode URL anfordern
POST https://engage.minitab.com/api/v1/subscription-id/Item
Anforderungs-Header
Kopfzeile Beschreibung
Authorization Erforderlich. Stellen Sie ein API-Token Bearer über das Bearer-Autorisierungsschema bereit. Das Token muss über die Berechtigung Create Idea verfügen.
Content-Type Erforderlich. Muss sein application/json.
Anforderungstext
Der Anforderungstext besteht aus einem JSON-Objekt mit einer erforderlichen Eigenschaft FileName.
{
    "FileName": "name of idea"
}
Optional können Sie ein Data einschließen, um Datenfeldwerte in der Idee festzulegen. Die Daten bestehen aus einwertigen Kategorie-Codenamen, die Objekten von Feld-Codenamen und -Werten zugeordnet sind.
{
    "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
        }
    }
}
Hinweis

Um die Liste der gültigen Datenfelder und Kategorienamen anzuzeigen, die für die Freigabe verfügbar sind, können Datenarchitekten eine CSV-Datei von der Einstellungen Registerkarte herunterladen Engage web app.

Hinweis

Nur Datenfelder, die für Steuerelemente im Ideenformular freigegeben sind, können in der Vorgangsanforderung Create Idea angegeben werden. Darüber hinaus wird das Angeben von Rich-Text-, Formel-, schreibgeschützten oder Datentabellenfeldern nicht unterstützt. Der Versuch, Daten für Felder bereitzustellen, die nicht für Steuerelemente im Ideenformular oder in Rich-Text-, Formel-, schreibgeschützten oder Datentabellenfeldern freigegeben sind, führt zu einem Fehler.

Muster-Anfrage
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     
        }
    }   
}

Antwort

Die Antwort enthält einen HTTP-Statuscode, eine Reihe von Antwortheadern und einen Text.

Statuscode
Ein erfolgreicher Vorgang gibt den Statuscode 202 (Akzeptiert) zurück.
Antwort-Header
Die Antwort für diesen Vorgang enthält die folgenden Header. Die Antwort kann auch zusätzliche standardmäßige HTTP-Header enthalten. Alle Standard-Header entsprechen der HTTP/1.1-Protokollspezifikation.
Kopfzeile Beschreibung
Location Eine URL, die zum Abrufen des Status des Auftrags verwendet werden kann.
Antwort-Text
Die Antwort für den Vorgang Create Idea enthält den Bezeichner des Auftrags, mit dem die Projektidee erstellt wird. Das JSON-Format ist unten dargestellt:
{
    "JobId": "479f6bea-360f-40ba-be0a-bd06c032c4fb"
}
Beispiel für eine Antwort
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"
}

Abrufen des Auftragsstatus

Der Vorgang Get Job Status ruft den Status des angegebenen Auftrags ab.

Bitten

Die Anforderung Get Job Status kann wie folgt erstellt werden. Ersetzen Sie subscription-id durch die ID Ihres Abonnements und job-id .
Methode URL anfordern
GET https://engage.minitab.com/api/v1/subscription-id/job/job-id
Header anfordern
Kopfzeile Beschreibung
Authorization Erforderlich. Stellen Sie ein API-Token Bearer über das Bearer-Autorisierungsschema bereit.
Muster-Anfrage
Request:
GET https://engage.minitab.com/api/v1/4906fcd496d94f738304dfcde754000a/job/479f6bea-360f-40ba-be0a-bd06c032c4fb HTTP/1.1

Headers:
Authorization: Bearer token

Antwort

Die Antwort enthält einen HTTP-Statuscode und einen Text.

Statuscode
Eine erfolgreiche Anforderung gibt den Statuscode 200 (OK) zurück.
Antwort-Text
Die Antwort für den Vorgang Get Job Status enthält eine Status , die die verschiedenen möglichen Zustände eines Auftrags darstellt, wie im folgenden Beispiel gezeigt.
{
    "Status": 1
}
Status der Stelle Beschreibung
0 Job noch nicht gestartet
1 Der Job hat begonnen; im Gange
2 Der Auftrag ist abgeschlossen
3 Job ist fehlgeschlagen
4 Job konnte nicht gefunden werden
5 Job wurde abgebrochen
Beispiel für eine Antwort
Response Status:
HTTP/1.1 200 OK

Response headers:
Content-Type: application/json

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