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
Read Dashboard Data Ruft globale Datenwerte aus allen Projekten ab, die in Dashboard-Berichten enthalten sind, und aus allen Workflow-Ideen.
Create File Erstellt eine neue Projektidee oder ein Nicht-Workflow-Projekt.
Hinweis

Empfohlen über Create Idea.
Create Idea Erstellt eine neue Projektidee.
Hinweis

Für erweiterte Funktionen verwenden Sie Datei erstellen.
Get Job Status Ruft die Statusinformationen für einen angegebenen Hintergrundauftrag ab.

Lesen von Dashboard-Daten

Der Read Dashboard Data Vorgang 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 für die Abfrage von Daten.

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

Bitten

Die Read Dashboard Data Anforderung kann wie folgt aufgebaut werden. Ersetzen Sie subscription-id sie 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 ü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 Standardheader HTTP 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 in JSON einem Format, das nach dem OData Standard strukturiert ist. 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" } ] }

Datei erstellen

Der Vorgang Create File initiiert einen Auftrag, um eine neue Projektidee oder ein Nicht-Workflow-Projekt in Ihrem Abonnement zu erstellen.

Bitten

Sie können die Anforderung Create File wie hier gezeigt erstellen. Ersetzen Sie subscription-id durch die ID Ihres Abonnements.
Methode URL anfordern
POST https://engage.minitab.com/api/v2/subscription-id/Item
Header anfordern
Kopfzeile Beschreibung
Authorization Erforderlich. Stellen Sie ein API-Token Bearer über das Bearer-Autorisierungsschema bereit. Das Token ist erforderlich, um über die Create Idea Berechtigung zu verfügen.
Content-Type Erforderlich. Muss application/jsonsein.
Anforderungstext
Der Anforderungstext besteht aus einem JSON-Objekt mit drei erforderlichen Eigenschaften: FileName, ProjectTemplateName und CreateFileType.
{ "Dateiname": "Name der Idee" "ProjectTemplateName":"Name der Projektvorlage, die für das Projekt verwendet werden soll", #Only für Projekte ohne Workflow erforderlich. Der Name muss mit einer Projektvorlage in Ihrem Abonnement übereinstimmen. "CreateFileType": 0, #(0 Idee, 1 Projekt ohne Workflow) }
Sie können eine der folgenden Optionen einbeziehen.
  • OwnerEmail: Die E-Mail-Adresse des Benutzers, dem diese neue Datei gehört.
  • IncludeInDashboard: Ein true- oder false-Wert, um den Standardwert in den Abonnementeinstellungen zu überschreiben.
  • Data: Das Objekt zum Festlegen von Datenfeldwerten in der Datei. Die Data bestehen aus einwertigen Kategorie-Codenamen, die Objekten von Feld-Codenamen und -Werten zugeordnet sind.
  • TableData: Das Objekt zum Festlegen von Tabellendatenwerten in der Datei. TableData besteht aus Codenamen von Datentabellenkategorien, die Objekten von Feldcodenamen und Wertesätzen zugeordnet sind.
    • Bei Ideen müssen sich Tabellendaten im Ideenformular befinden.
    • Wenn in Tabellendaten die Anzahl der Werte für ein Feld ungleich ist, werden die Felder mit weniger Werten in den verbleibenden Zeilen auf ihre Standardwerte gesetzt.
    • Verwenden Sie null, um einen leeren Wert abzurufen.
    • Einige Datentabellen verfügen über erforderliche Felder, z. B. [teammember / name]. Wenn die Pflichtfelder leer sind, wird kein Projekt erstellt.
  • NotificationRecipients: E-Mail-Adressen, die eine Nachricht erhalten sollen, wenn der Vorgang Create File erfolgreich ist oder fehlschlägt.
{ "Dateiname": "Name der Idee", "ProjectTemplateName":"Einfach machen", "CreateFileType":1, "OwnerEmail":"user@company.com", "IncludeInDashboard":false, "NotificationRecipients": ["fmae@mortgage.gov", "user@domain.com"], "Daten": { "Projektzusammenfassung": { "belt_level": "Grünes Band", "critical_to": "Langer Text\r\nmit\r\nZeilenumbrüchen" }, "annualized_financial": { "annualized_actual_hard_savings": 100 } } "TableData":{ "teammember":{ "name":["John Q. Public","Fannie Mae","Freddie Mac"], "role":["Project Leader",null,"Mortgage Broker"], "email":[null,"fmae@mortgage.gov"] }, "task":{ "subject":["refinance","origination"] "startdate":["2025-04-24"] } } } }
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

Um den Namen eines Teammitglieds auf eine Teamrolle festzulegen (Sponsor, Champion, Financial Analyst usw.), verbinden Sie das Feld Team Member / Role mit dem Feld Role. Im vorherigen Beispiel wird die Teamrolle/der Projektleiter auf "John Q. Öffentlich" festgelegt.

Hinweis

Der Vorgang Create File unterstützt das Festlegen von Datenwerten für alle Felder nicht. Der Versuch, Daten für Formeln, Rich-Text- oder interne Felder bereitzustellen, führt zu einem Fehler.

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

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 Standardheader HTTP 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 Create File Vorgang enthält den Bezeichner des Auftrags, mit dem das Projekt oder die Idee erstellt wird. Das JSON Format ist unten dargestellt: 
{ "JobId": "479f6bea-360f-40ba-be0a-bd06c032c4fb" }

Idee erstellen

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

Wenn Sie eine neue Projektidee erstellen, können Sie die Option "Idee erstellen" verwenden, es wird jedoch empfohlen, eine Datei zu erstellen .

Bitten

Sie können die Anforderung "Idee erstellen " wie hier gezeigt erstellen. Ersetzen Sie subscription-id sie 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 über das Bearer Autorisierungsschema bereit. Das Token ist erforderlich, um über die Create Idea Berechtigung zu verfügen.
Content-Type Erforderlich. Muss application/jsonsein.
Anforderungstext
Der Anforderungstext besteht aus einem JSON Objekt mit einer erforderlichen Eigenschaft FileName.
{ "FileName": "name of idea" }
Optional können Sie ein Data Objekt zum Festlegen von Datenfeldwerten in die Idee einschließen. 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 Engageweb app.

Hinweis

Nur Datenfelder, die für Steuerelemente im Ideenformular freigegeben sind, dürfen in der Create Idea Vorgangsanforderung 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 Standardheader HTTP 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 Create Idea Vorgang 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 Get Job Status Vorgang ruft den Status des angegebenen Auftrags ab.

Bitten

Die Anforderung „Auftragsstatus abrufen" kann wie folgt erstellt werden. Ersetzen Sie subscription-id diese durch die ID Ihres Abonnements und job-id durch eine gültige 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 ü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 Get Job Status Vorgang enthält eine Status ganzzahlige Eigenschaft, 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.