Meisterplan
Meisterplan ist ein Ressourcenverwaltungstool auf Portfolioebene, mit dem Portfolio- und Ressourcenmanager Mitarbeiter über Teams und Initiativen hinweg verwalten können, unabhängig davon, ob Ihre Arbeit traditionell, agil oder hybrid ist. Verwenden Sie sie, um sichere Portfolioentscheidungen zu treffen und Ressourcenkonflikte interaktiv zu lösen und zu lösen.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Meisterplan-Support |
| URL | https://help.meisterplan.com/ |
| support@meisterplan.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | itdesign GmbH |
| Webseite | https://meisterplan.com |
| Datenschutzrichtlinie | https://meisterplan.com/privacy-and-data-protection/ |
| Kategorien | Unternehmensführung; Business Intelligence |
Meisterplan ist ein Ressourcenverwaltungstool auf Portfolioebene, mit dem Portfolio- und Ressourcenmanager Mitarbeiter über Teams und Initiativen hinweg verwalten können, unabhängig davon, ob Ihre Arbeit traditionell, agil oder hybrid ist. Verwenden Sie sie, um sichere Portfolioentscheidungen zu treffen und Ressourcenkonflikte interaktiv zu lösen und zu lösen. Sehen Sie die Ressourcenverfügbarkeit und -kapazität, gewinnen Sie Einblicke in Projekte, priorisieren und ausrichten Sie Projektportfolios an Strategien, und generieren Sie Echtzeitszenariosimulationen mit Meisterplan. Mit dem Meisterplan Connector können Sie Meisterplan mit allen Tools integrieren, die Ihre Teams verwenden, damit niemand eine doppelte Wartung der Projektdaten durchführen muss. Ob Sie ein Projekt aktualisieren oder einen genehmigten Time-Off-Antrag stellen müssen, Meisterplan und der Meisterplan Connector können den Prozess nahtlos gestalten.
Voraussetzungen
Um den Meisterplan-Connector zu verwenden, benötigen Sie ein Meisterplan-Konto . Um mit Meisterplan zu beginnen, fordern Sie entweder eine Demo an, oder nehmen Sie eine Testversion.
So erhalten Sie Anmeldeinformationen
Wenn Sie den Meisterplan Connector verwenden, wird ein Anmeldedialogfeld angezeigt, in dem Sie die Region auswählen müssen, in der sich Ihr Meisterplan-System befindet (usa oder EU). Geben Sie als Nächstes Ihre Anmeldeinformationen für Meisterplan ein, d. h. Benutzername und Kennwort, und klicken Sie auf "Anmelden". Klicken Sie dann auf "Autorisieren ", um dem Verbinder den Zugriff auf Ihr Meisterplan-System zu ermöglichen.
Erste Schritte mit Ihrem Connector
Häufige Anwendungsfälle sind:
- Aktualisieren von Projektinformationen: Wenn Sie eine Änderung an einem Projekt in einem Projektmanagementtool (z. B. Trello) vornehmen, z. B. das Aktualisieren des Status, wird das entsprechende Projekt in Meisterplan automatisch aktualisiert.
- Synchronisierung von Zuordnungen: Wenn Sie eine Zuordnung in einer Onlinetabelle wie MS Excel bearbeiten, wird die entsprechende Zuordnung in Meisterplan automatisch aktualisiert.
- Halten Sie Ihre Ressourcenabwesendungen auf dem neuesten Stand: Wenn Sie eine Abwesenheitsanfrage von einem Ihrer Mitarbeiter in einer Onlinetabelle wie Excel genehmigen, wird der entsprechende Ressourceneintrag in Meisterplan automatisch aktualisiert.
- Hinzufügen neuer Projekte zu Meisterplan: Wenn Sie ein neues Projekt in einem Ihrer Tools hinzufügen, wird automatisch ein neues Projekt in Meisterplan erstellt.
- Hinzufügen neuer Ressourcen zu Meisterplan: Wenn Sie Ihr Online-Arbeitsblatt mit einem neuen Mitarbeiter aktualisieren, werden sie automatisch zum Ressourcenpool in Meisterplan hinzugefügt.
- Regelmäßige Aktualisierung der Mitarbeiterdaten: Wenn Sie die Adresse einer Ressource in Ihrer Onlinetabelle ändern, wird der entsprechende Ressourceneintrag in Meisterplan automatisch aktualisiert.
- Herstellen einer Verbindung mit Microsoft Teams: Wenn ein Projekt in Meisterplan aktualisiert wird, erhalten Sie eine Benachrichtigung im konfigurierten Teams-Kanal. Diese Benachrichtigung kann so konfiguriert werden, dass sie den Link zum Projekt in Meisterplan enthält, damit Sie das Projekt schnell öffnen können, um weitere Details zu erhalten.
- Stellen Sie eine Verbindung mit Ihrem MS Office her: Wenn ein neues Projekt in Meisterplan hinzugefügt wird, erhalten angegebene Kollegen per E-Mail benachrichtigt. Sie können den Fluss auch so konfigurieren, dass das neue Projekt ihrer externen Sicherungsquelle in MS Office hinzugefügt wird.
Bekannte Probleme und Einschränkungen
- Es gibt derzeit keine bekannten Einschränkungen oder Einschränkungen. Allgemeine Informationen zur Ratelimitierung, Paginierung usw. finden Sie in der REST-API-Dokumentation.
Häufige Fehler und Abhilfemaßnahmen
Der Meisterplan Connector verwendet die Meisterplan REST-API. Eine Beschreibung einschließlich Statuscodes finden Sie in der REST-API-Dokumentation. Weitere Informationen finden Sie im Hilfecenter.
Häufig gestellte Fragen
Welche Meisterplan-Benutzerrechte muss ich in der Lage sein, den Connector zu verwenden?
- Ihr Meisterplan-Benutzer muss über die Access Meisterplan-APIs verfügen und externe Anwendungen verbinden.
- Ihr Meisterplan-Benutzer muss über Lese- und Bearbeitungsrechte für die Felder verfügen, die Sie mithilfe des Connectors lesen oder aktualisieren möchten.
Kann ich den Connector mit der Meisterplan Basic Edition verwenden?
- Ja, der Connector wird von allen Meisterplan-Editionen unterstützt. Einige Aktionen sind nur mit dem Meisterplan Pro-Edition oder Premium-Edition verfügbar.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Region | Schnur | Region Ihres gehosteten Meisterplan-Systems | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen aller OBS-Einheiten |
Dieser Endpunkt gibt eine Liste aller OBS-Einheiten für den angegebenen OBS-Typ zurück. |
| Abrufen aller OBS-Typen |
Dieser Endpunkt gilt nur für OBS-Typen. Verwenden Sie zum Abrufen von OBS-Einheiten /obsTypes/<obs-type-id>/obsUnits |
| Abrufen der ist-Zeit, die nach ID gearbeitet wurde |
Gibt die einzelne tatsächliche Arbeitszeit zurück, die durch die angegebene ID angegeben wurde. |
| Abrufen der Kapazitätssegmente aller Rollen |
Gibt die Kapazitätssegmente für alle Rollen zurück. Wenn keine Kapazitätssegmente für eine bestimmte Rolle vorhanden sind, sind ihre Rollenkapazitäten leer. |
| Abrufen der Kapazitätssegmente einer Rolle |
Gibt die Kapazitätssegmente für die durch die angegebene ID angegebene Rolle zurück. Gibt eine leere Liste zurück, wenn keine Kapazitätssegmente vorhanden sind. |
| Abrufen einer Liste der ist geleisteten Zeit |
Gibt eine Liste der ist-Zeit zurück, die für alle Projekte eines bestimmten Szenarios gearbeitet wurde. Beachten Sie, dass die tatsächlichen Arbeitszeitdaten selbst von ihrem Szenario unabhängig sind. |
| Abrufen einer Liste der tatsächlichen Finanzereignisse |
Gibt eine Liste der tatsächlichen finanziellen Ereignisse eines Projekts zurück. |
| Abrufen einer Liste von Abwesenheiten |
Gibt eine Liste der Abwesenheiten der Ressource zurück. |
| Abrufen einer Liste von Aufgaben |
Dieser Endpunkt wird paginiert. Es gibt eine Liste von Aufgaben bis zur angegebenen PAGESIZE zurück. |
| Abrufen einer Liste von Benutzern |
Gibt eine Liste von Benutzern zurück. Ermöglicht das Filtern nach "userName" oder "externalId". |
| Abrufen einer Liste von Finanzdaten |
Gibt eine Liste der Finanzdaten eines Projekts zurück. |
| Abrufen einer Liste von Kalender exceptions |
Erhalten Sie eine Liste aller Ausnahmen für diesen Kalender in Ihrem Meisterplan-System. |
| Abrufen einer Liste von Kalendern |
Erhalten Sie eine Liste aller Kalender in Ihrem Meisterplan-System. |
| Abrufen einer Liste von Meilensteinabhängigkeiten |
Gibt eine Liste der Meilensteinabhängigkeiten eines Szenarios zurück. |
| Abrufen einer Liste von Meilensteinen |
Gibt eine Liste der Meilensteine eines Projekts zurück. |
| Abrufen einer Liste von Portfolios |
Gibt eine Liste aller verfügbaren Portfolios zurück. Wenn Sie nicht berechtigt sind, ein Portfolio anzuzeigen, gibt sie eine Liste aller verfügbaren Portfolios zurück, auf die Sie über Ihr API-Token zugreifen können. Wenn Sie nicht das Recht haben, ein Portfolio anzuzeigen, wird eine leere Liste zurückgegeben. |
| Abrufen einer Liste von Programmen |
Gibt eine Liste von Programmen im angegebenen Szenario zurück. |
| Abrufen einer Liste von Projekten |
Dieser Endpunkt wird paginiert. Es gibt eine Liste von Projekten bis zur angegebenen PAGESIZE zurück. |
| Abrufen einer Liste von Projektkommentaren |
Gibt eine Liste der Projektkommentare zurück. |
| Abrufen einer Liste von Ressourcen |
Dieser Endpunkt wird paginiert. Es gibt eine Liste der Ressourcen bis zur angegebenen PAGESIZE-Datei zurück. |
| Abrufen einer Liste von Rollen |
Gibt eine Liste aller verfügbaren Rollen zurück. Wenn keine Rollen verfügbar sind, wird eine leere Liste zurückgegeben. |
| Abrufen einer Liste von Szenarien |
Es gibt eine Liste von Szenarien zurück. |
| Abrufen einer Liste von Teams |
Dieser Endpunkt wird paginiert. Es gibt eine Liste von Teams bis zur angegebenen PAGESIZE-Liste zurück. |
| Abrufen einer Liste von Zuordnungen |
Gibt eine Liste der Zuordnungen eines Projekts zurück. |
| Abrufen einer Liste von Zuordnungskommentaren |
Gibt eine Liste der Zuordnungskommentare zurück. |
| Abrufen einer OBS-Einheit |
Dieser Endpunkt gibt eine einzelne OBS-Einheit zurück. |
| Abrufen eines Benutzers nach ID |
Gibt einen Benutzer zurück. |
| Abrufen eines OBS-Typs nach ID |
Dieser Endpunkt gilt nur für OBS-Typen. Verwenden Sie zum Abrufen von OBS-Einheiten /obsTypes/<obs-type-id>/obsUnits |
| Abrufen eines Projektkommentars nach ID |
Gibt einen Projektkommentar zurück. |
| Abrufen eines Zuordnungskommentars nach ID |
Gibt einen Zuordnungskommentar zurück. |
| Abrufen von Abweichungen vom Kalender |
Liest Abweichungen der Arbeitszeiten der Ressource. Wenn keine Anfangs- und Endwerte übergeben werden, werden alle Abweichungen der angeforderten Ressource zurückgegeben. Wenn nur Der Anfang übergeben wird, werden alle Abweichungen ab dieser Zeit zurückgegeben. Wenn nur das Ende übergeben wird, werden alle Abweichungen bis zu diesem Punkt zurückgegeben. |
| Abrufen von Abwesenheiten nach ID |
Gibt die individuelle Abwesenheit zurück, die durch die angegebene ID angegeben wird. |
| Abrufen von Zuordnungen nach ID |
Gibt die durch die angegebene ID angegebene individuelle Zuordnung zurück. |
| Abwesenheit löschen |
Löscht eine Abwesenheit. |
| Abwesenheiten ersetzen |
Mit diesem Endpunkt können Sie alle Abwesenheiten einer Ressource ersetzen. Das Ergebnis entspricht dem Löschen aller vorhandenen Abwesenheiten, und die übergebenen Abwesenheiten werden erneut erstellt. Sie können die Abfrageparameter "start" und "end" verwenden, um einen Zeitraum zum Ersetzen vorhandener Abwesenheiten anzugeben. Wenn Sie diese Parameter nicht verwenden, werden alle Abwesenheiten durch die neu gesendeten Abwesenheiten ersetzt. |
| Abwesenheiten erstellen |
Verwenden Sie diese Anforderung, um eine Abwesenheit für einen bestimmten Zeitraum hinzuzufügen. Dieser Zeitraum kann mithilfe der Start- und Endattribute der Anforderung definiert werden. |
| Aktualisieren der Kapazitätssegmente einer Rolle |
Aktualisiert die Kapazitätssegmente für die durch die angegebene ID angegebene Rolle. Um alle Kapazitätssegmente zu löschen, senden Sie ein Segment ohne Anfang oder Ende und 0 Kapazität |
| Aktualisieren einer OBS-Einheit |
Aktualisiert den Namen einer einzelnen OBS-Einheit oder verschiebt sie in ein anderes übergeordnetes Element. |
| Aktualisieren von Abweichungen vom Kalender |
Verwenden Sie diese Anforderung, um alle Kalenderabweichungen einer Ressource für einen bestimmten Zeitraum zu ersetzen. Dieser Zeitraum kann mithilfe der Stammstart- und Endattribute der Anforderung definiert werden. Geben Sie die neue Liste der Kalenderabweichungen mit der Eigenschaft "Abweichungen" an. Beachten Sie, dass alle Abweichungen in der angegebenen Periode durch die in der Eigenschaft "Abweichungen" aufgeführten Abweichungen überschrieben werden.
Alle Abweichungen werden in eine sequenzielle Struktur abgeflacht. Fälle überlappender Abweichungen werden gelöst, indem sie vorrang vor Abweichungen haben, die später im Array auftreten. |
| Aktualisieren von Abwesenheiten |
Verwenden Sie diese Anforderung, um eine Abwesenheit zu aktualisieren. |
| Aktualisieren von OBS-Typen |
Führt eine Aktualisierung eines durch die angegebene ID angegebenen OBS-Typs aus. |
| Aktualisieren von Teams |
Führen Sie eine Aktualisierung für ein team aus, das durch die angegebene ID angegeben ist. Pfade Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt. |
| Aktuelle Arbeitszeit erstellen oder aktualisieren |
Mit diesem Endpunkt können Sie neue ist-Arbeitszeiten erstellen und die vorhandene aktuelle Arbeitszeit eines Projekts durch eine Entität (Ressource oder Rolle) aktualisieren. Wir werden die tatsächliche Arbeitszeit, die für Buchungsdaten, die in der Anforderung für ein bestimmtes Projekt und eine bestimmte Entität nicht angegeben sind, nicht aktualisiert. Mit der Moduseigenschaft können Sie steuern, ob ein vorhandener Wert für die aktuelle Arbeitszeit durch den neuen Wert ersetzt wird oder ob der Wert der Buchung in der Anforderung hinzugefügt wird. Beachten Sie, dass die tatsächlichen Arbeitszeitdaten selbst von ihrem Szenario unabhängig sind. Es wird für jedes projektübergreifende Szenario gleich sein. Eine Anforderung ist auf 5000 tatsächliche Zeitarbeitswerte pro Projekt und Ressource/Rolle beschränkt. |
| Aktuelle Arbeitszeit nach ID löschen |
Löscht eine tatsächliche Zeit, die in einem bestimmten Projekt eines Szenarios gearbeitet wurde. |
| Aktuelle Finanzereignisse ersetzen |
Ersetzt tatsächliche finanzielle Ereignisse eines bestimmten Projekts innerhalb eines Szenarios. Eine Anforderung ist auf 5000 tatsächliche Finanzereignisse pro Projekt beschränkt. |
| Aktuelles Finanzereignis aktualisieren |
Gibt das aktualisierte tatsächliche Finanzereignis zurück. |
| Aktuelles Finanzereignis erstellen |
Gibt das neu erstellte tatsächliche Finanzereignis zurück. |
| Aktuelles Finanzereignis löschen |
Löscht ein tatsächliches Finanzereignis in einem bestimmten Projekt eines Szenarios. |
| Aktuelles Finanzereignis nach ID abrufen |
Gibt das einzelne tatsächliche Finanzereignis zurück, das durch die angegebene ID angegeben wird. |
| Alle aktuellen Arbeitszeiten löschen, die von der Projekt-ID bearbeitet wurden |
Löscht alle tatsächlichen Arbeitszeiten eines bestimmten Projekts. |
| Aufgabe erstellen oder aktualisieren |
Erstellt oder aktualisiert einen Vorgang mit den angegebenen Feldern. |
| Aufgabe löschen |
Löscht einen Vorgang in einem bestimmten Projekt. |
| Aufgabe nach ID abrufen |
Gibt den einzelnen Vorgang zurück, der durch die angegebene ID angegeben wird. |
| Aufgaben ersetzen |
Dieser Endpunkt wird verwendet, um alle vorhandenen Vorgänge eines bestimmten Projekts durch eine neue Liste von Vorgängen zu ersetzen, die in der Anforderung bereitgestellt werden. Funktionsweise: Sie senden eine Liste von Vorgängen für ein bestimmtes Projekt. Das System synchronisiert die Aufgaben des Projekts mit dieser Liste mithilfe des Vorgangsschlüssels als Bezeichner. Dies bedeutet:
|
| Erstellen des OBS-Typs |
Erstellt einen OBS-Typ mit den angegebenen Daten. Gibt den neu erstellten OBS-Typ zurück. |
| Erstellen einer Meilensteinabhängigkeit |
Gibt die ID der neu erstellten Meilensteinabhängigkeit zurück. |
| Erstellen einer OBS-Einheit |
Erstellt eine OBS-Einheit mit den angegebenen Daten. Gibt die neu erstellte OBS-Einheit zurück. |
| Erstellen oder Aktualisieren des Vorgangsverwaltungslinks |
Mit diesem Endpunkt können Sie einem Projekt einen Vorgangsverwaltungslink hinzufügen oder die externalViewUrl aktualisieren. |
| Erstellen oder Aktualisieren von Zuordnungen |
Mit diesem Endpunkt können Sie neue Zuordnungen erstellen und vorhandene Zuordnungen eines Projekts aktualisieren. Änderungen werden nur für die angegebenen Datumsbereiche sowie für die angegebenen Ressourcen und Rollen vorgenommen. |
| Erstellen von Teams |
Erstellt ein Team anhand der angegebenen Felder und gibt die neu erstellte zurück. Pfade Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt. |
| Finanzdaten aktualisieren |
Aktualisiert ein Finanzereignis anhand der ID in einem bestimmten Projekt eines Szenarios. |
| Finanzdaten löschen |
Löscht ein Finanzereignis in einem bestimmten Projekt eines Szenarios. |
| Finanzdaten nach ID abrufen |
Gibt das einzelne Finanzereignis zurück, das durch die angegebene ID angegeben wird. |
| Finanzersetzung |
Ersetzt finanzbezogene Ereignisse eines bestimmten Projekts innerhalb eines Szenarios. |
| Finanzmathematik erstellen |
Gibt das neu erstellte Finanzereignis zurück. |
| Geschäftsziele |
Gibt alle Geschäftsziele zurück. |
| Kalender aktualisieren |
Führen Sie eine Aktualisierung für einen kalender aus, der durch die angegebene ID angegeben ist. Pfade Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt. |
| Kalender-Ausnahmen aktualisieren |
Verwenden Sie diese Anforderung, um alle Kalender exceptions für einen bestimmten Zeitraum zu ersetzen. Dieser Zeitraum kann mithilfe der Stammstart- und Endattribute der Anforderung definiert werden. Geben Sie die neue Liste der Kalender exceptions mit der Exceptions-Eigenschaft an. Beachten Sie, dass alle Ausnahmen im angegebenen Zeitraum von den in der Ausnahmeeigenschaft aufgeführten Ausnahmen überschrieben werden.
|
| Kalender erstellen |
Erstellen Sie einen Kalender mit den angegebenen Daten. Gibt den neu erstellten Kalender zurück. |
| Kalender löschen |
Löscht einen Kalender in Ihrem Meisterplan-System. Bitte beachten Sie, dass der Standardkalender oder ein übergeordnetes Element des Standardkalenders nicht gelöscht werden kann. |
| Kalender nach ID abrufen |
Holen Sie sich einen Kalender in Ihrem Meisterplan-System. Verwenden Sie die spezielle ID defaultCalendar, um den Standardkalender abzurufen. |
| Löschen einer OBS-Einheit nach ID |
Löscht die durch die angegebene ID angegebene OBS-Einheit. Wenn die OBS-Einheit mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl. |
| Löschen eines OBS-Typs nach ID |
Löschen Sie den durch die angegebene ID angegebenen OBS-Typ. Wenn der OBS-Typ mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl. |
| Löschen von Ressourcen |
Löschen Sie die durch die angegebene ID angegebene Ressource. Wenn die Ressource mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl. |
| Meilensteinabhängigkeiten löschen |
Löscht eine Meilensteinabhängigkeit in einem bestimmten Szenario. |
| Meilensteine aktualisieren |
Führen Sie eine Aktualisierung für einen meilenstein aus, der durch die angegebene ID angegeben ist. |
| Meilensteine ersetzen |
Ersetzt Meilensteine eines bestimmten Projekts innerhalb eines Szenarios. |
| Meilensteine erstellen |
Gibt den neu erstellten Meilenstein zurück. |
| Meilensteine löschen |
Löscht einen Meilenstein in einem bestimmten Projekt eines Szenarios. |
| Meilensteine nach ID abrufen |
Gibt den einzelnen Meilenstein zurück, der durch die angegebene ID angegeben wird. |
| Prioritäten aktualisieren |
Dieser Endpunkt aktualisiert die Prioritäten von Projekten und Programmen. |
| Programm nach ID abrufen |
Gibt das einzelne Programm zurück, das durch die angegebene ID angegeben wird. |
| Programme aktualisieren |
Führen Sie eine Aktualisierung für ein durch die angegebene ID angegebenes Programm aus. |
| Programme erstellen |
Erstellt ein Programm mit den angegebenen Feldern und gibt das neu erstellte Programm zurück. |
| Programme löschen |
Löscht ein programm, das durch die angegebene ID angegeben ist. |
| Projekte aktualisieren |
Führen Sie eine Aktualisierung für ein Projekt durch die angegebene ID aus. |
| Projekte erstellen |
Erstellt ein Projekt mit den angegebenen Feldern und gibt das neu erstellte Projekt zurück. |
| Projekte löschen |
Löscht ein Projekt in einem bestimmten Szenario. |
| Projekte nach ID abrufen |
Gibt das einzelne Projekt zurück, das durch die angegebene ID angegeben wird. |
| Ressourcen aktualisieren |
Führen Sie eine Aktualisierung für eine Ressource durch die angegebene ID aus. Pfade Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt. |
| Ressourcen erstellen |
Erstellt eine Ressource durch die angegebenen Felder und gibt die neu erstellte zurück. Pfade Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt. |
| Ressourcen nach ID abrufen |
Gibt die einzelne Ressource zurück, die durch die angegebene ID angegeben wird. |
| Rollen aktualisieren |
Führen Sie eine Aktualisierung für eine durch die angegebene ID angegebene Rolle aus. Um eine teilweise Aktualisierung durchführen zu können, müssen nur die aktualisierten Felder gesendet werden. Zum Löschen eines Feldwerts muss das Feld mit einem expliziten Nullwert gesendet werden. Felder mit einem Standardwert werden auf ihre Standardeinstellung zurückgesetzt, wenn sie auf NULL festgelegt ist. Pfade Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt. |
| Rollen erstellen |
Gibt die erstellte Rolle bei Erfolg zurück. Pfade Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt. |
| Rollen löschen |
Löschen Sie die durch die angegebene ID angegebene Rolle. Wenn die Rolle mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl. |
| Rollen nach ID abrufen |
Gibt die einzelne Rolle zurück, die durch die angegebene ID angegeben wird. |
| Sprint nach ID abrufen |
Gibt den einzelnen Sprint zurück, der durch die angegebene ID angegeben wird. |
| Standardkalender festlegen |
Legt einen vorhandenen Kalender als Standardkalender in Ihrem Meisterplan-System fest. |
| Szenarien nach ID abrufen |
Gibt das einzelne Szenario zurück, das durch die angegebene ID angegeben wird. HINWEIS: Sie können "planOfRecord" als ID für den Plan des Datensatzszenarios verwenden. |
| Team nach ID abrufen |
Gibt das einzelne Team zurück, das durch die angegebene ID angegeben ist. |
| Teams löschen |
Löschen Sie das durch die angegebene ID angegebene Team. Wenn das Team mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl. |
| Vorgangsverwaltungslink abrufen |
Gibt einen Vorgangsverwaltungslink eines Projekts zurück. |
| Vorgangsverwaltungslink löschen |
Löscht einen Vorgangsverwaltungslink eines Projekts. |
| Zuordnungen aktualisieren |
Mit diesem Endpunkt können Sie vorhandene Zuordnungen eines Projekts aktualisieren. Änderungen werden nur für die angegebenen Datumsbereiche sowie für die angegebenen Ressourcen und Rollen vorgenommen. |
| Zuordnungen löschen |
Löscht eine Zuordnung in einem bestimmten Projekt eines Szenarios. |
| Zuweisungen ersetzen |
Mit diesem Endpunkt können Sie alle Zuordnungen eines Projekts ersetzen. Das Ergebnis entspricht dem Löschen aller vorhandenen Zuordnungen, und die übergebenen Zuordnungen werden erneut erstellt. |
Abrufen aller OBS-Einheiten
Dieser Endpunkt gibt eine Liste aller OBS-Einheiten für den angegebenen OBS-Typ zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Obs-Typ-ID
|
obsTypeId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Abrufen aller OBS-Typen
Dieser Endpunkt gilt nur für OBS-Typen. Verwenden Sie zum Abrufen von OBS-Einheiten /obsTypes/<obs-type-id>/obsUnits
Gibt zurück
Abrufen der ist-Zeit, die nach ID gearbeitet wurde
Gibt die einzelne tatsächliche Arbeitszeit zurück, die durch die angegebene ID angegeben wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Ist-ID
|
actualsId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Ist-Zeit, die nach ID gearbeitet hat
- ActualTimeWorkedByIdResponse
Abrufen der Kapazitätssegmente aller Rollen
Gibt die Kapazitätssegmente für alle Rollen zurück. Wenn keine Kapazitätssegmente für eine bestimmte Rolle vorhanden sind, sind ihre Rollenkapazitäten leer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Abrufen der Kapazitätssegmente einer Rolle
Gibt die Kapazitätssegmente für die durch die angegebene ID angegebene Rolle zurück. Gibt eine leere Liste zurück, wenn keine Kapazitätssegmente vorhanden sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Rollen-ID
|
roleId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Abrufen einer Liste der ist geleisteten Zeit
Gibt eine Liste der ist-Zeit zurück, die für alle Projekte eines bestimmten Szenarios gearbeitet wurde. Beachten Sie, dass die tatsächlichen Arbeitszeitdaten selbst von ihrem Szenario unabhängig sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Filter
|
filter | string |
Zeichenfolgen-JSON-Objekt mit einer Teilmenge der Eigenschaften des erwarteten Objekts. |
Gibt zurück
- Paginierte
- PaginatedResponseActualTimeWorkedResponse
Abrufen einer Liste der tatsächlichen Finanzereignisse
Gibt eine Liste der tatsächlichen finanziellen Ereignisse eines Projekts zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Abrufen einer Liste von Abwesenheiten
Gibt eine Liste der Abwesenheiten der Ressource zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Startdatum
|
startDate | date |
Startdatum für den Filterzeitzeitraum |
|
|
Endtermin
|
finishDate | date |
Inklusiver Endtermin zum Filtern des Zeitraums. |
Gibt zurück
Abrufen einer Liste von Aufgaben
Dieser Endpunkt wird paginiert. Es gibt eine Liste von Aufgaben bis zur angegebenen PAGESIZE zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Key
|
key | string |
Wählt alle Objekte aus, die dem Schlüssel exakt entsprechen. |
Gibt zurück
Abrufen einer Liste von Benutzern
Gibt eine Liste von Benutzern zurück. Ermöglicht das Filtern nach "userName" oder "externalId".
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Filter
|
filter | string |
Zeichenfolgen-JSON-Objekt mit einer Teilmenge der Eigenschaften des erwarteten Objekts. |
Gibt zurück
- Paginierte
- PaginatedResponseUserResponse
Abrufen einer Liste von Finanzdaten
Gibt eine Liste der Finanzdaten eines Projekts zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Abrufen einer Liste von Kalender exceptions
Erhalten Sie eine Liste aller Ausnahmen für diesen Kalender in Ihrem Meisterplan-System.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kalender-ID
|
calendarId | True | string |
Interner Meisterplan-Bezeichner |
|
Startdatum
|
startDate | date |
Startdatum |
|
|
Enddatum
|
endDate | date |
Enddatum |
Gibt zurück
Abrufen einer Liste von Kalendern
Erhalten Sie eine Liste aller Kalender in Ihrem Meisterplan-System.
Gibt zurück
Abrufen einer Liste von Meilensteinabhängigkeiten
Gibt eine Liste der Meilensteinabhängigkeiten eines Szenarios zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
Gibt zurück
- Paginierte
- PaginatedResponseMilestoneDependencyResponse
Abrufen einer Liste von Meilensteinen
Gibt eine Liste der Meilensteine eines Projekts zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Abrufen einer Liste von Portfolios
Gibt eine Liste aller verfügbaren Portfolios zurück. Wenn Sie nicht berechtigt sind, ein Portfolio anzuzeigen, gibt sie eine Liste aller verfügbaren Portfolios zurück, auf die Sie über Ihr API-Token zugreifen können. Wenn Sie nicht das Recht haben, ein Portfolio anzuzeigen, wird eine leere Liste zurückgegeben.
Gibt zurück
Abrufen einer Liste von Programmen
Gibt eine Liste von Programmen im angegebenen Szenario zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Filter
|
filter | string |
Zeichenfolgen-JSON-Objekt mit einer Teilmenge der Eigenschaften des erwarteten Objekts. Wählt alle Objekte aus, die exakt den angegebenen Eigenschaften entsprechen. Programme können nach programKey und Name durchsucht werden. Hinweis: Achten Sie darauf, Den Parameter zu codieren. { "programKey": string, "name": string } |
|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Paginierte
- PaginatedResponseProgramGetAllResponse
Abrufen einer Liste von Projekten
Dieser Endpunkt wird paginiert. Es gibt eine Liste von Projekten bis zur angegebenen PAGESIZE zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Filter
|
filter | string |
Zeichenfolgen-JSON-Objekt mit einer Teilmenge der Eigenschaften des erwarteten Objekts. |
Gibt zurück
Abrufen einer Liste von Projektkommentaren
Gibt eine Liste der Projektkommentare zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Paginierte
- PaginatedResponseProjectCommentResponse
Abrufen einer Liste von Ressourcen
Dieser Endpunkt wird paginiert. Es gibt eine Liste der Ressourcen bis zur angegebenen PAGESIZE-Datei zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Filter
|
filter | string |
Zeichenfolgen-JSON-Objekt mit einer Teilmenge der Eigenschaften des erwarteten Objekts. |
Gibt zurück
Abrufen einer Liste von Rollen
Gibt eine Liste aller verfügbaren Rollen zurück. Wenn keine Rollen verfügbar sind, wird eine leere Liste zurückgegeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Filter
|
filter | string |
Zeichenfolgen-JSON-Objekt mit einer Teilmenge der Eigenschaften des erwarteten Objekts. |
Gibt zurück
Abrufen einer Liste von Szenarien
Abrufen einer Liste von Teams
Dieser Endpunkt wird paginiert. Es gibt eine Liste von Teams bis zur angegebenen PAGESIZE-Liste zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Filter
|
filter | string |
Zeichenfolgen-JSON-Objekt mit einer Teilmenge der Eigenschaften des erwarteten Objekts. Wählt alle Objekte aus, die exakt den angegebenen Eigenschaften entsprechen. Hinweis: Achten Sie darauf, Den Parameter zu codieren. { "resourceKey": string, "name": string } |
Gibt zurück
Abrufen einer Liste von Zuordnungen
Gibt eine Liste der Zuordnungen eines Projekts zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Abrufen einer Liste von Zuordnungskommentaren
Gibt eine Liste der Zuordnungskommentare zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite nach
|
pageAfter | string |
Der Cursor, nach dem Ergebnisse abgerufen werden sollen. Der Cursor kann aus einer vorherigen Anforderung entnommen werden. |
|
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Paginierte
- PaginatedResponseAllocationCommentResponse
Abrufen einer OBS-Einheit
Dieser Endpunkt gibt eine einzelne OBS-Einheit zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Obs-Typ-ID
|
obsTypeId | True | string |
Interner Meisterplan-Bezeichner |
|
Obs Unit Id
|
obsUnitId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Obs-Einheit
- ObsUnitResponse
Abrufen eines Benutzers nach ID
Gibt einen Benutzer zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Benutzer
- UserResponse
Abrufen eines OBS-Typs nach ID
Dieser Endpunkt gilt nur für OBS-Typen. Verwenden Sie zum Abrufen von OBS-Einheiten /obsTypes/<obs-type-id>/obsUnits
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Obs-Typ-ID
|
obsTypeId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Obs-Typ
- ObsTypeResponse
Abrufen eines Projektkommentars nach ID
Gibt einen Projektkommentar zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Kommentar-ID
|
commentId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Projektkommentar
- ProjectCommentResponse
Abrufen eines Zuordnungskommentars nach ID
Gibt einen Zuordnungskommentar zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Zuordnungskommentar-ID
|
allocationCommentId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Zuordnungskommentar
- AllocationCommentResponse
Abrufen von Abweichungen vom Kalender
Liest Abweichungen der Arbeitszeiten der Ressource. Wenn keine Anfangs- und Endwerte übergeben werden, werden alle Abweichungen der angeforderten Ressource zurückgegeben. Wenn nur Der Anfang übergeben wird, werden alle Abweichungen ab dieser Zeit zurückgegeben. Wenn nur das Ende übergeben wird, werden alle Abweichungen bis zu diesem Punkt zurückgegeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Start
|
start | date |
Startdatum für den Filterzeitzeitraum |
|
|
Fertigstellen
|
finish | date |
Endtermin für den Filterzeitzeitraum |
Gibt zurück
Abrufen von Abwesenheiten nach ID
Gibt die individuelle Abwesenheit zurück, die durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Abwesenheits-ID
|
absenceId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Abwesenheit
- AbsenceResponse
Abrufen von Zuordnungen nach ID
Gibt die durch die angegebene ID angegebene individuelle Zuordnung zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Zuordnungs-ID
|
allocationId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Zuteilung
- AllocationResponse
Abwesenheit löschen
Löscht eine Abwesenheit.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Abwesenheits-ID
|
absenceId | True | string |
Interner Meisterplan-Bezeichner |
Abwesenheiten ersetzen
Mit diesem Endpunkt können Sie alle Abwesenheiten einer Ressource ersetzen. Das Ergebnis entspricht dem Löschen aller vorhandenen Abwesenheiten, und die übergebenen Abwesenheiten werden erneut erstellt. Sie können die Abfrageparameter "start" und "end" verwenden, um einen Zeitraum zum Ersetzen vorhandener Abwesenheiten anzugeben. Wenn Sie diese Parameter nicht verwenden, werden alle Abwesenheiten durch die neu gesendeten Abwesenheiten ersetzt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Start
|
start | date |
Startdatum des Ersatzzeitraums |
|
|
ENDE
|
end | date |
Inklusives Enddatum des Ersatzzeitraums. |
|
|
Start
|
start | True | string |
Format: JJJJ-MM-DD |
|
Fertigstellen
|
finish | True | string |
Format: JJJJ-MM-DD |
|
Starttagtyp
|
startDayType | string |
Der Standardwert ist FULL_DAY |
|
|
Endtagtyp
|
finishDayType | string |
Der Standardwert ist FULL_DAY |
Abwesenheiten erstellen
Verwenden Sie diese Anforderung, um eine Abwesenheit für einen bestimmten Zeitraum hinzuzufügen. Dieser Zeitraum kann mithilfe der Start- und Endattribute der Anforderung definiert werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Start
|
start | True | string |
Format: JJJJ-MM-DD |
|
Fertigstellen
|
finish | True | string |
Format: JJJJ-MM-DD |
|
Starttagtyp
|
startDayType | string |
Der Standardwert ist FULL_DAY |
|
|
Endtagtyp
|
finishDayType | string |
Der Standardwert ist FULL_DAY |
Gibt zurück
- Abwesenheit
- AbsenceResponse
Aktualisieren der Kapazitätssegmente einer Rolle
Aktualisiert die Kapazitätssegmente für die durch die angegebene ID angegebene Rolle. Um alle Kapazitätssegmente zu löschen, senden Sie ein Segment ohne Anfang oder Ende und 0 Kapazität
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Rollen-ID
|
roleId | True | string |
Interner Meisterplan-Bezeichner |
|
start
|
start | date | ||
|
beenden
|
finish | date | ||
|
fte
|
fte | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
|
|
Tage
|
days | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
|
|
Stunden
|
hours | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
Gibt zurück
Aktualisieren einer OBS-Einheit
Aktualisiert den Namen einer einzelnen OBS-Einheit oder verschiebt sie in ein anderes übergeordnetes Element.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Obs-Typ-ID
|
obsTypeId | True | string |
Interner Meisterplan-Bezeichner |
|
Obs Unit Id
|
obsUnitId | True | string |
Interner Meisterplan-Bezeichner |
|
Name
|
name | string | ||
|
Übergeordnete ID
|
parentId | string |
Gibt zurück
- Obs-Einheit
- ObsUnitResponse
Aktualisieren von Abweichungen vom Kalender
Verwenden Sie diese Anforderung, um alle Kalenderabweichungen einer Ressource für einen bestimmten Zeitraum zu ersetzen. Dieser Zeitraum kann mithilfe der Stammstart- und Endattribute der Anforderung definiert werden. Geben Sie die neue Liste der Kalenderabweichungen mit der Eigenschaft "Abweichungen" an. Beachten Sie, dass alle Abweichungen in der angegebenen Periode durch die in der Eigenschaft "Abweichungen" aufgeführten Abweichungen überschrieben werden.
- Wenn null für den Anfangs- und Endzeitraum verwendet wird, werden alle Kalenderabweichungen der Ressource überschrieben – Wenn nur der Anfangstermin des Zeitraums definiert ist, werden alle Abweichungen, die von dieser Zeit beginnen, überschrieben - Wenn nur das Enddatum des Zeitraums definiert ist, werden alle Abweichungen bis zu diesem Punkt überschrieben – Wenn null für den Anfangs- und/oder Endtermin einer Kalenderabweichung verwendet wird, die Abweichung wird davon ausgegangen, dass sie von oder bis zum oben angegebenen Stammanfangs- oder Endtermin dauert.
Alle Abweichungen werden in eine sequenzielle Struktur abgeflacht. Fälle überlappender Abweichungen werden gelöst, indem sie vorrang vor Abweichungen haben, die später im Array auftreten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Start
|
start | date | ||
|
Fertigstellen
|
finish | date | ||
|
Start
|
start | date | ||
|
Fertigstellen
|
finish | date | ||
|
Relative Kapazität
|
relativeCapacity | True | double |
Gibt zurück
Aktualisieren von Abwesenheiten
Verwenden Sie diese Anforderung, um eine Abwesenheit zu aktualisieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Abwesenheits-ID
|
absenceId | True | string |
Interner Meisterplan-Bezeichner |
|
Start
|
start | string |
Format: JJJJ-MM-DD |
|
|
Fertigstellen
|
finish | string |
Format: JJJJ-MM-DD |
|
|
Starttagtyp
|
startDayType | string | ||
|
Endtagtyp
|
finishDayType | string |
Gibt zurück
- Abwesenheit
- AbsenceResponse
Aktualisieren von OBS-Typen
Führt eine Aktualisierung eines durch die angegebene ID angegebenen OBS-Typs aus.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Obs-Typ-ID
|
obsTypeId | True | string |
Interner Meisterplan-Bezeichner |
|
Name
|
name | True | string |
Gibt zurück
- Obs-Typ
- ObsTypeResponse
Aktualisieren von Teams
Führen Sie eine Aktualisierung für ein team aus, das durch die angegebene ID angegeben ist.
Pfade
Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Team-ID
|
teamId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Team dargestellt durch ein JSON-Dokument. |
Gibt zurück
Aktuelle Arbeitszeit erstellen oder aktualisieren
Mit diesem Endpunkt können Sie neue ist-Arbeitszeiten erstellen und die vorhandene aktuelle Arbeitszeit eines Projekts durch eine Entität (Ressource oder Rolle) aktualisieren. Wir werden die tatsächliche Arbeitszeit, die für Buchungsdaten, die in der Anforderung für ein bestimmtes Projekt und eine bestimmte Entität nicht angegeben sind, nicht aktualisiert. Mit der Moduseigenschaft können Sie steuern, ob ein vorhandener Wert für die aktuelle Arbeitszeit durch den neuen Wert ersetzt wird oder ob der Wert der Buchung in der Anforderung hinzugefügt wird. Beachten Sie, dass die tatsächlichen Arbeitszeitdaten selbst von ihrem Szenario unabhängig sind. Es wird für jedes projektübergreifende Szenario gleich sein. Eine Anforderung ist auf 5000 tatsächliche Zeitarbeitswerte pro Projekt und Ressource/Rolle beschränkt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
ID
|
id | True | string |
Die ID der Entität, mit der dieser tatsächliche Arbeitsaufwandeintrag verknüpft ist. Legen Sie den Typ auf RESOLVE_BY_KEY_OR_NAME fest, um Ressourcen- und Teamschlüssel oder Rollennamen stattdessen automatisch aufzulösen. |
|
Typ
|
type | string | ||
|
Team-ID
|
teamId | string |
Die Team-ID der Entität, mit der dieser tatsächliche Arbeitsaufwandeintrag verknüpft ist |
|
|
Buchungsdatum
|
bookingDate | True | date |
Datum dieser Buchung |
|
Stunden
|
hours | True | double |
Ist-Zeit in Stunden gearbeitet |
|
Kostenart
|
costType | string |
default: siehe Meisterplan-Dokumentation. |
|
|
Kosten pro Stunde
|
costPerHour | double |
Kosten pro Stunde für diese Buchung |
|
|
Modus
|
mode | string |
Gibt zurück
- Ist-Zeit gearbeitet
- ActualTimeWorkedResponse
Aktuelle Arbeitszeit nach ID löschen
Löscht eine tatsächliche Zeit, die in einem bestimmten Projekt eines Szenarios gearbeitet wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Ist-ID
|
actualsId | True | string |
Interner Meisterplan-Bezeichner |
Aktuelle Finanzereignisse ersetzen
Ersetzt tatsächliche finanzielle Ereignisse eines bestimmten Projekts innerhalb eines Szenarios. Eine Anforderung ist auf 5000 tatsächliche Finanzereignisse pro Projekt beschränkt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Typ
|
type | True | string | |
|
Betrag
|
amount | True | double | |
|
Buchungsdatum
|
bookingDate | True | date | |
|
Description
|
description | string | ||
|
Name
|
name | string |
Die Finanzkategorie muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
Aktuelles Finanzereignis aktualisieren
Gibt das aktualisierte tatsächliche Finanzereignis zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Finanz-Ist-ID
|
actualFinancialEventId | True | string |
Interner Meisterplan-Bezeichner |
|
Typ
|
type | string | ||
|
Betrag
|
amount | double | ||
|
Buchungsdatum
|
bookingDate | string |
Format: JJJJ-MM-DD |
|
|
Description
|
description | string | ||
|
Name
|
name | string |
Die Finanzkategorie muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
Gibt zurück
- Finanzielle Ist-Werte
- FinancialActualsResponse
Aktuelles Finanzereignis erstellen
Gibt das neu erstellte tatsächliche Finanzereignis zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Typ
|
type | True | string | |
|
Betrag
|
amount | True | double | |
|
Buchungsdatum
|
bookingDate | True | date | |
|
Description
|
description | string | ||
|
Name
|
name | string |
Die Finanzkategorie muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
Gibt zurück
- Finanzielle Ist-Werte
- FinancialActualsResponse
Aktuelles Finanzereignis löschen
Löscht ein tatsächliches Finanzereignis in einem bestimmten Projekt eines Szenarios.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Finanz-Ist-ID
|
actualFinancialEventId | True | string |
Interner Meisterplan-Bezeichner |
Aktuelles Finanzereignis nach ID abrufen
Gibt das einzelne tatsächliche Finanzereignis zurück, das durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Finanz-Ist-ID
|
actualFinancialEventId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Finanzielle Ist-Werte
- FinancialActualsResponse
Alle aktuellen Arbeitszeiten löschen, die von der Projekt-ID bearbeitet wurden
Löscht alle tatsächlichen Arbeitszeiten eines bestimmten Projekts.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Aufgabe erstellen oder aktualisieren
Erstellt oder aktualisiert einen Vorgang mit den angegebenen Feldern.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Durch ein JSON-Dokument dargestellte Aufgabe. |
Aufgabe löschen
Löscht einen Vorgang in einem bestimmten Projekt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Vorgangs-ID
|
taskId | True | string |
Interner Meisterplan-Bezeichner |
Aufgabe nach ID abrufen
Gibt den einzelnen Vorgang zurück, der durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Vorgangs-ID
|
taskId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Aufgaben ersetzen
Dieser Endpunkt wird verwendet, um alle vorhandenen Vorgänge eines bestimmten Projekts durch eine neue Liste von Vorgängen zu ersetzen, die in der Anforderung bereitgestellt werden. Funktionsweise: Sie senden eine Liste von Vorgängen für ein bestimmtes Projekt. Das System synchronisiert die Aufgaben des Projekts mit dieser Liste mithilfe des Vorgangsschlüssels als Bezeichner. Dies bedeutet:
- Aufgaben, die sich derzeit im System befinden, aber nicht in Ihrer Liste, werden gelöscht. – Aufgaben in Ihrer Liste, die nicht im System vorhanden sind, werden erstellt. – Aufgaben, die sowohl im System als auch in Ihrer Liste vorhanden sind, werden aktualisiert, wenn Änderungen vorhanden sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Anforderung zum Ersetzen von Aufgaben
|
tasksReplaceRequest | True | dynamic |
Durch ein JSON-Dokument dargestellte Aufgabe. |
Erstellen des OBS-Typs
Erstellt einen OBS-Typ mit den angegebenen Daten. Gibt den neu erstellten OBS-Typ zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Gibt zurück
- Obs-Typ
- ObsTypeResponse
Erstellen einer Meilensteinabhängigkeit
Gibt die ID der neu erstellten Meilensteinabhängigkeit zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Von Meilenstein-ID
|
fromMilestoneId | True | string | |
|
Zur Meilenstein-ID
|
toMilestoneId | True | string |
Gibt zurück
- Meilensteinabhängigkeit erstellen
- MilestoneDependencyCreateResponse
Erstellen einer OBS-Einheit
Erstellt eine OBS-Einheit mit den angegebenen Daten. Gibt die neu erstellte OBS-Einheit zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Obs-Typ-ID
|
obsTypeId | True | string |
Interner Meisterplan-Bezeichner |
|
Name
|
name | True | string | |
|
Übergeordnete ID
|
parentId | string |
Gibt zurück
- Obs-Einheit
- ObsUnitResponse
Erstellen oder Aktualisieren des Vorgangsverwaltungslinks
Mit diesem Endpunkt können Sie einem Projekt einen Vorgangsverwaltungslink hinzufügen oder die externalViewUrl aktualisieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Task Management Link dargestellt durch ein JSON-Dokument. |
Gibt zurück
Erstellen oder Aktualisieren von Zuordnungen
Mit diesem Endpunkt können Sie neue Zuordnungen erstellen und vorhandene Zuordnungen eines Projekts aktualisieren. Änderungen werden nur für die angegebenen Datumsbereiche sowie für die angegebenen Ressourcen und Rollen vorgenommen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
ID
|
id | True | string |
Die ID der Entität, mit der diese Zuordnung verknüpft ist. Legen Sie den Typ auf RESOLVE_BY_KEY_OR_NAME fest, um stattdessen Ressourcenschlüssel oder Rollennamen automatisch aufzulösen. |
|
Typ
|
type | string |
Steuern Sie, wie der Wert in der Feld-ID interpretiert wird. RESOURCE löst Ressourcen nach UUID auf. ROLE löst Rollen durch UUID auf. RESOLVE_BY_KEY_OR_NAME löst Ressourcen entweder nach Ressourcenschlüssel oder Rollen nach Rollennamen auf. |
|
|
Projektrolle
|
projectRole | string |
Die Rollen-ID, mit der diese Zuordnung verknüpft ist. Dieses Feld ist nur in Kombination mit den Typen RESOURCE oder RESOLVE_BY_KEY_OR_NAME gültig. Wenn der Typ auf RESOLVE_BY_KEY_OR_NAME festgelegt ist, wird projectRole anhand des Namens aufgelöst. |
|
|
Start
|
start | True | date | |
|
Fertigstellen
|
finish | True | date | |
|
Fte
|
fte | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
|
|
Days
|
days | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
|
|
Stunden
|
hours | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
Gibt zurück
- Zuteilung
- AllocationResponse
Erstellen von Teams
Erstellt ein Team anhand der angegebenen Felder und gibt die neu erstellte zurück.
Pfade
Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Nutzlast
|
payload | True | dynamic |
Team dargestellt durch ein JSON-Dokument. |
Gibt zurück
Finanzdaten aktualisieren
Aktualisiert ein Finanzereignis anhand der ID in einem bestimmten Projekt eines Szenarios.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Finanz-ID
|
financialsId | True | string |
Interner Meisterplan-Bezeichner |
|
Typ
|
type | string | ||
|
Betrag
|
amount | double | ||
|
Ein
|
on | True | string |
Meilenstein ist nur in Kombination mit einem Wert in der Feldmeilenstein-ID gültig. Datum ist nur in Kombination mit einem Wert im Feld dueDate gültig. |
|
Meilenstein-ID
|
milestoneId | string |
Ist nur in Kombination mit "on: Milestone" gültig. Der Meilenstein muss im Projekt vorhanden sein. Sie wird nicht implizit erstellt. |
|
|
Fälligkeitsdatum
|
dueDate | string |
Ist nur in Kombination mit dem Datum (Format: JJJJ-MM-DD) gültig. |
|
|
Description
|
description | string | ||
|
Name
|
name | string |
Die Finanzkategorie muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
Gibt zurück
- Finanzen
- FinancialsResponse
Finanzdaten löschen
Löscht ein Finanzereignis in einem bestimmten Projekt eines Szenarios.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Finanz-ID
|
financialsId | True | string |
Interner Meisterplan-Bezeichner |
Finanzdaten nach ID abrufen
Gibt das einzelne Finanzereignis zurück, das durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Finanz-ID
|
financialsId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Finanzen
- FinancialsResponse
Finanzersetzung
Ersetzt finanzbezogene Ereignisse eines bestimmten Projekts innerhalb eines Szenarios.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Typ
|
type | True | string | |
|
Betrag
|
amount | True | double | |
|
Ein
|
on | True | string |
Meilenstein ist nur in Kombination mit einem Wert in der Feldmeilenstein-ID gültig. Datum ist nur in Kombination mit einem Wert im Feld dueDate gültig. |
|
Meilenstein-ID
|
milestoneId | string |
Ist nur in Kombination mit "on: Milestone" gültig. Der Meilenstein muss im Projekt vorhanden sein. Sie wird nicht implizit erstellt. |
|
|
Fälligkeitsdatum
|
dueDate | string |
Ist nur in Kombination mit dem Datum (Format: JJJJ-MM-DD) gültig. |
|
|
Description
|
description | string | ||
|
Name
|
name | string |
Die Finanzkategorie muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
Finanzmathematik erstellen
Gibt das neu erstellte Finanzereignis zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Typ
|
type | True | string | |
|
Betrag
|
amount | True | double | |
|
Ein
|
on | True | string |
Meilenstein ist nur in Kombination mit einem Wert in der Feldmeilenstein-ID gültig. Datum ist nur in Kombination mit einem Wert im Feld dueDate gültig. |
|
Meilenstein-ID
|
milestoneId | string |
Ist nur in Kombination mit "on: Milestone" gültig. Der Meilenstein muss im Projekt vorhanden sein. Sie wird nicht implizit erstellt. |
|
|
Fälligkeitsdatum
|
dueDate | string |
Ist nur in Kombination mit dem Datum (Format: JJJJ-MM-DD) gültig. |
|
|
Description
|
description | string | ||
|
Name
|
name | string |
Die Finanzkategorie muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
Gibt zurück
- Finanzen
- FinancialsResponse
Geschäftsziele
Kalender aktualisieren
Führen Sie eine Aktualisierung für einen kalender aus, der durch die angegebene ID angegeben ist.
Pfade
Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kalender-ID
|
calendarId | True | string |
Interner Meisterplan-Bezeichner |
|
Name
|
name | string | ||
|
Monday
|
monday | True | double | |
|
Tuesday
|
tuesday | True | double | |
|
Wednesday
|
wednesday | True | double | |
|
Thursday
|
thursday | True | double | |
|
Friday
|
friday | True | double | |
|
Saturday
|
saturday | True | double | |
|
Sonntag
|
sunday | True | double |
Gibt zurück
- Calendar
- CalendarResponse
Kalender-Ausnahmen aktualisieren
Verwenden Sie diese Anforderung, um alle Kalender exceptions für einen bestimmten Zeitraum zu ersetzen. Dieser Zeitraum kann mithilfe der Stammstart- und Endattribute der Anforderung definiert werden. Geben Sie die neue Liste der Kalender exceptions mit der Exceptions-Eigenschaft an. Beachten Sie, dass alle Ausnahmen im angegebenen Zeitraum von den in der Ausnahmeeigenschaft aufgeführten Ausnahmen überschrieben werden.
- Wenn Null für den Anfangs- und Endzeitraum verwendet wird, werden alle Ausnahmen des Kalenders überschrieben – Wenn nur das Startdatum des Zeitraums definiert ist, werden alle Ausnahmen, die von diesem Zeitpunkt beginnen, überschrieben – Wenn nur das Enddatum des Zeitraums definiert ist, werden alle Ausnahmen bis zu diesem Punkt überschrieben – Wenn eine Ausnahme entfernt wird und ein übergeordneter Kalender zu diesem Datum eine Ausnahme aufweist, Dieser Kalender erbt die Ausnahme vom übergeordneten Kalender.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kalender-ID
|
calendarId | True | string |
Interner Meisterplan-Bezeichner |
|
Start
|
start | date | ||
|
Fertigstellen
|
finish | date | ||
|
Datum
|
date | True | date | |
|
Arbeitszeit
|
workingHours | True | double | |
|
Description
|
description | string |
Kalender erstellen
Erstellen Sie einen Kalender mit den angegebenen Daten. Gibt den neu erstellten Kalender zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string | |
|
Übergeordnete ID
|
parentId | string | ||
|
Monday
|
monday | True | double | |
|
Tuesday
|
tuesday | True | double | |
|
Wednesday
|
wednesday | True | double | |
|
Thursday
|
thursday | True | double | |
|
Friday
|
friday | True | double | |
|
Saturday
|
saturday | True | double | |
|
Sonntag
|
sunday | True | double |
Gibt zurück
- Calendar
- CalendarResponse
Kalender löschen
Löscht einen Kalender in Ihrem Meisterplan-System. Bitte beachten Sie, dass der Standardkalender oder ein übergeordnetes Element des Standardkalenders nicht gelöscht werden kann.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kalender-ID
|
calendarId | True | string |
Interner Meisterplan-Bezeichner |
Kalender nach ID abrufen
Holen Sie sich einen Kalender in Ihrem Meisterplan-System. Verwenden Sie die spezielle ID defaultCalendar, um den Standardkalender abzurufen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kalender-ID
|
calendarId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Calendar
- CalendarResponse
Löschen einer OBS-Einheit nach ID
Löscht die durch die angegebene ID angegebene OBS-Einheit. Wenn die OBS-Einheit mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Obs-Typ-ID
|
obsTypeId | True | string |
Interner Meisterplan-Bezeichner |
|
Obs Unit Id
|
obsUnitId | True | string |
Interner Meisterplan-Bezeichner |
Löschen eines OBS-Typs nach ID
Löschen Sie den durch die angegebene ID angegebenen OBS-Typ. Wenn der OBS-Typ mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Obs-Typ-ID
|
obsTypeId | True | string |
Interner Meisterplan-Bezeichner |
Löschen von Ressourcen
Löschen Sie die durch die angegebene ID angegebene Ressource. Wenn die Ressource mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
Meilensteinabhängigkeiten löschen
Löscht eine Meilensteinabhängigkeit in einem bestimmten Szenario.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Meilenstein-Abhängigkeits-ID
|
milestoneDependencyId | True | string |
Interner Meisterplan-Bezeichner |
Meilensteine aktualisieren
Führen Sie eine Aktualisierung für einen meilenstein aus, der durch die angegebene ID angegeben ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Meilenstein-ID
|
milestoneId | True | string |
Interner Meisterplan-Bezeichner |
|
Name
|
name | string | ||
|
Datum
|
date | string |
Format: JJJJ-MM-DD |
|
|
Name
|
name | string |
Die Projektphase muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
|
|
Wert
|
value | string |
Gibt zurück
- Meilenstein
- MilestoneResponse
Meilensteine ersetzen
Ersetzt Meilensteine eines bestimmten Projekts innerhalb eines Szenarios.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Name
|
name | True | string | |
|
Datum
|
date | True | string |
Format: JJJJ-MM-DD |
|
Name
|
name | string |
Die Projektphase muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
|
|
Wert
|
value | string |
Meilensteine erstellen
Gibt den neu erstellten Meilenstein zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Name
|
name | True | string | |
|
Datum
|
date | True | string |
Format: JJJJ-MM-DD |
|
Name
|
name | string |
Die Projektphase muss vor der Erstellung vorhanden sein. Sie wird nicht implizit erstellt. |
|
|
Wert
|
value | string |
Gibt zurück
- Meilenstein
- MilestoneResponse
Meilensteine löschen
Löscht einen Meilenstein in einem bestimmten Projekt eines Szenarios.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Meilenstein-ID
|
milestoneId | True | string |
Interner Meisterplan-Bezeichner |
Meilensteine nach ID abrufen
Gibt den einzelnen Meilenstein zurück, der durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Meilenstein-ID
|
milestoneId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Meilenstein
- MilestoneResponse
Prioritäten aktualisieren
Dieser Endpunkt aktualisiert die Prioritäten von Projekten und Programmen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
ID
|
id | True | string |
Der ID-Wert kann ein Projekt oder ein Programm sein. |
|
Position
|
position | string |
Die Position kann "FIRST" oder "LAST" sein. FIRST ist Standard |
|
|
ID
|
id | True | string |
Der ID-Wert kann ein Projekt oder ein Programm sein. |
|
Position
|
position | string |
Die Position kann "FIRST" oder "LAST" sein. FIRST ist Standard |
|
|
ID
|
id | True | string |
Der ID-Wert kann ein Projekt oder ein Programm sein. |
|
Position
|
position | string |
Die Position kann "FIRST" oder "LAST" sein. FIRST ist Standard |
Programm nach ID abrufen
Gibt das einzelne Programm zurück, das durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Programm-ID
|
programId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Programme aktualisieren
Führen Sie eine Aktualisierung für ein durch die angegebene ID angegebenes Programm aus.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Programm-ID
|
programId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Programm dargestellt durch ein JSON-Dokument. |
Gibt zurück
Programme erstellen
Erstellt ein Programm mit den angegebenen Feldern und gibt das neu erstellte Programm zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Programm dargestellt durch ein JSON-Dokument. |
Gibt zurück
Programme löschen
Löscht ein programm, das durch die angegebene ID angegeben ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Programm-ID
|
programId | True | string |
Interner Meisterplan-Bezeichner |
Projekte aktualisieren
Führen Sie eine Aktualisierung für ein Projekt durch die angegebene ID aus.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Projekt dargestellt durch ein JSON-Dokument. |
Gibt zurück
Projekte erstellen
Erstellt ein Projekt mit den angegebenen Feldern und gibt das neu erstellte Projekt zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Projekt dargestellt durch ein JSON-Dokument. |
Gibt zurück
Projekte löschen
Löscht ein Projekt in einem bestimmten Szenario.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Projekte nach ID abrufen
Gibt das einzelne Projekt zurück, das durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Ressourcen aktualisieren
Führen Sie eine Aktualisierung für eine Ressource durch die angegebene ID aus.
Pfade
Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Ressource dargestellt durch ein JSON-Dokument. |
Gibt zurück
Ressourcen erstellen
Erstellt eine Ressource durch die angegebenen Felder und gibt die neu erstellte zurück.
Pfade
Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Nutzlast
|
payload | True | dynamic |
Ressource dargestellt durch ein JSON-Dokument. |
Gibt zurück
Ressourcen nach ID abrufen
Gibt die einzelne Ressource zurück, die durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ressourcen-ID
|
resourceId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Rollen aktualisieren
Führen Sie eine Aktualisierung für eine durch die angegebene ID angegebene Rolle aus. Um eine teilweise Aktualisierung durchführen zu können, müssen nur die aktualisierten Felder gesendet werden. Zum Löschen eines Feldwerts muss das Feld mit einem expliziten Nullwert gesendet werden. Felder mit einem Standardwert werden auf ihre Standardeinstellung zurückgesetzt, wenn sie auf NULL festgelegt ist.
Pfade
Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rollen-ID
|
roleId | True | string |
Interner Meisterplan-Bezeichner |
|
Nutzlast
|
payload | True | dynamic |
Rolle dargestellt durch ein JSON-Dokument. |
Gibt zurück
Rollen erstellen
Gibt die erstellte Rolle bei Erfolg zurück.
Pfade
Pfade, die durch / (z. B. in Kalendern und OBS-Einheitenpfaden) getrennt sind, können Pfadsegmente definieren, die /durch Escapezeichen mit //. Der Weg Europa/Berlin/Amsterdam wird z.B. als ['Europa', 'Berlin/Amsterdam' interpretiert. Eine ungleiche Menge von Schrägstrichen wird als das folgende Segment interpretiert, das mit einem oder mehreren Schrägstrichen beginnt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Nutzlast
|
payload | True | dynamic |
Rolle dargestellt durch ein JSON-Dokument. |
Gibt zurück
Rollen löschen
Löschen Sie die durch die angegebene ID angegebene Rolle. Wenn die Rolle mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rollen-ID
|
roleId | True | string |
Interner Meisterplan-Bezeichner |
Rollen nach ID abrufen
Gibt die einzelne Rolle zurück, die durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rollen-ID
|
roleId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Sprint nach ID abrufen
Gibt den einzelnen Sprint zurück, der durch die angegebene ID angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sprint-ID
|
sprintId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Body
- SprintResponse
Standardkalender festlegen
Legt einen vorhandenen Kalender als Standardkalender in Ihrem Meisterplan-System fest.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID
|
id | True | string |
Szenarien nach ID abrufen
Gibt das einzelne Szenario zurück, das durch die angegebene ID angegeben wird. HINWEIS: Sie können "planOfRecord" als ID für den Plan des Datensatzszenarios verwenden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
- Scenario
- ScenarioResponse
Team nach ID abrufen
Gibt das einzelne Team zurück, das durch die angegebene ID angegeben ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Team-ID
|
teamId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Teams löschen
Löschen Sie das durch die angegebene ID angegebene Team. Wenn das Team mit der angegebenen ID nicht vorhanden ist, schlägt die Anforderung fehl.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Team-ID
|
teamId | True | string |
Interner Meisterplan-Bezeichner |
Vorgangsverwaltungslink abrufen
Gibt einen Vorgangsverwaltungslink eines Projekts zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Gibt zurück
Vorgangsverwaltungslink löschen
Löscht einen Vorgangsverwaltungslink eines Projekts.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
Zuordnungen aktualisieren
Mit diesem Endpunkt können Sie vorhandene Zuordnungen eines Projekts aktualisieren. Änderungen werden nur für die angegebenen Datumsbereiche sowie für die angegebenen Ressourcen und Rollen vorgenommen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Zuordnungs-ID
|
allocationId | True | string |
Interner Meisterplan-Bezeichner |
|
Start
|
start | True | date | |
|
Fertigstellen
|
finish | True | date | |
|
Fte
|
fte | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
|
|
Days
|
days | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
|
|
Stunden
|
hours | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
Gibt zurück
- Zuteilung
- AllocationResponse
Zuordnungen löschen
Löscht eine Zuordnung in einem bestimmten Projekt eines Szenarios.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
Zuordnungs-ID
|
allocationId | True | string |
Interner Meisterplan-Bezeichner |
Zuweisungen ersetzen
Mit diesem Endpunkt können Sie alle Zuordnungen eines Projekts ersetzen. Das Ergebnis entspricht dem Löschen aller vorhandenen Zuordnungen, und die übergebenen Zuordnungen werden erneut erstellt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Szenario-ID
|
scenarioId | True | string |
Interner Meisterplan-Bezeichner |
|
Projekt-ID
|
projectId | True | string |
Interner Meisterplan-Bezeichner |
|
ID
|
id | True | string |
Die ID der Entität, mit der diese Zuordnung verknüpft ist. Legen Sie den Typ auf RESOLVE_BY_KEY_OR_NAME fest, um stattdessen Ressourcenschlüssel oder Rollennamen automatisch aufzulösen. |
|
Typ
|
type | string |
Steuern Sie, wie der Wert in der Feld-ID interpretiert wird. RESOURCE löst Ressourcen nach UUID auf. ROLE löst Rollen durch UUID auf. RESOLVE_BY_KEY_OR_NAME löst Ressourcen entweder nach Ressourcenschlüssel oder Rollen nach Rollennamen auf. |
|
|
Projektrolle
|
projectRole | string |
Die Rollen-ID, mit der diese Zuordnung verknüpft ist. Dieses Feld ist nur in Kombination mit den Typen RESOURCE oder RESOLVE_BY_KEY_OR_NAME gültig. Wenn der Typ auf RESOLVE_BY_KEY_OR_NAME festgelegt ist, wird projectRole anhand des Namens aufgelöst. |
|
|
Start
|
start | True | date | |
|
Fertigstellen
|
finish | True | date | |
|
Fte
|
fte | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
|
|
Days
|
days | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
|
|
Stunden
|
hours | double |
Die Anforderung akzeptiert entweder FTE, Stunden oder Tage. |
Trigger
| Erstellen von Webhook |
Erstellt einen Webhook durch die angegebenen Felder und gibt den neu erstellten Zurück. 1000 Webhooks werden derzeit pro System unterstützt. |
Erstellen von Webhook
Erstellt einen Webhook durch die angegebenen Felder und gibt den neu erstellten Zurück. 1000 Webhooks werden derzeit pro System unterstützt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignistypen
|
eventTypes | True | array of string |
Es muss mindestens ein Ereignistyp bereitgestellt werden. |
|
Szenario-ID
|
scenarioId | True | string |
Das Szenario, das Sie abonnieren möchten. |
|
Projektkennung
|
projectId | string |
Die projectId ist optional. Es ist nur erforderlich, wenn Sie ein bestimmtes Projekt abonnieren möchten. |
Gibt zurück
Definitionen
UserRefResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzer-ID
|
id | string | |
|
Anzeigename des Benutzers
|
displayName | string |
ListResponseRoleCapacityResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of RoleCapacityResponse |
RoleCapacityResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
start
|
start | date |
Startdatum dieses Rollenkapazitätssegments. Wahlfrei. |
|
beenden
|
finish | date |
Enddatum dieses Rollenkapazitätssegments. Wahlfrei. |
|
fte
|
fte | double |
Die Kapazität der Rolle in FTE |
MilestoneResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Name
|
name | string | |
|
Datum
|
date | string |
Format: JJJJ-MM-DD |
|
Projektphase
|
projectPhase | ProjectPhaseResponse | |
|
Der Status
|
status | StatusResponse |
ProjectPhaseResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
name | string |
StatusResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string | |
|
Anzeigename
|
displayName | string |
FinanceCategoryResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
name | string |
FinancialsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Typ
|
type | string | |
|
Betrag
|
amount | double | |
|
Finanzplanung
|
timing | FinancialsTimingResponse | |
|
Description
|
description | string | |
|
Finanzkategorie
|
category | FinanceCategoryResponse |
FinancialsTimingResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ein
|
on | string | |
|
Meilenstein-ID
|
milestoneId | string |
Nur vorhanden, wenn der Timing-Typ meilensteingleich ist |
|
Fälligkeitsdatum
|
dueDate | date |
FinancialActualsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Typ
|
type | string | |
|
Betrag
|
amount | double | |
|
Buchungsdatum
|
bookingDate | string |
Format: JJJJ-MM-DD |
|
Description
|
description | string | |
|
Finanzkategorie
|
category | FinanceCategoryResponse |
AllocatedEntityResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der Entität, mit der diese Zuordnung verknüpft ist |
|
Typ
|
type | string |
Der Entitätstyp für diese Zuordnung |
|
Projektrolle
|
projectRole | string |
Wird nur festgelegt, wenn der Typ "RESOURCE" entspricht |
AllocationResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID dieser Zuordnung |
|
Zugeordnete Entität
|
allocatedEntity | AllocatedEntityResponse | |
|
Segmente
|
segments | array of AllocationSegmentResponse |
Die Zeitsegmente der Zuordnung |
AllocationSegmentResponse
Die Zeitsegmente der Zuordnung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Start
|
start | date |
Startdatum dieser Zuordnung |
|
Fertigstellen
|
finish | date |
Enddatum dieser Zuordnung |
|
Stunden
|
hours | double |
Zuordnungswert in Stunden |
ActualTimeWorkedResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Actuals-Entitätslink
|
bookedEntity | ActualsEntityLinkResponse | |
|
Buchungen
|
bookings | array of ActualsBookingResponse |
Buchungsdatum und -stunden dieses tatsächlich geleisteten Zeiteintrags |
ActualsBookingResponse
Buchungsdatum und -stunden dieses tatsächlich geleisteten Zeiteintrags
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
id | string |
Buchungs-ID dieses tatsächlich geleisteten Zeiteintrags |
|
Buchungsdatum
|
bookingDate | date |
Buchungsdatum dieses tatsächlichen Arbeitstermins |
|
Stunden
|
hours | double |
Ist-Zeit in Stunden gearbeitet |
|
Kostenart
|
costType | string | |
|
Kosten pro Stunde
|
costPerHour | double |
ActualsEntityLinkResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der Entität, mit der dieser aktuelle Arbeitszeiteintrag verknüpft ist |
|
Typ
|
type | string |
Der Entitätstyp für diesen tatsächlichen Arbeitszeiteintrag |
|
Team-ID
|
teamId | string |
Die Team-ID der Entität, mit der dieser tatsächliche Arbeitsaufwandeintrag verknüpft ist |
MilestoneDependencyCreateResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
CalendarDeviationResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Start
|
start | date | |
|
Fertigstellen
|
finish | date | |
|
Relative Kapazität
|
relativeCapacity | double |
ListResponseCalendarDeviationResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of CalendarDeviationResponse |
AbsenceResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der Abwesenheit |
|
Startdatum
|
start | date |
Startdatum dieser Abwesenheit |
|
Endtermin
|
finish | date |
Endtermin dieser Abwesenheit |
|
Typ des Startabwesendtags
|
startDayType | string | |
|
Typ des Endes des Abwesenheitstags
|
finishDayType | string |
ObsTypeResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Name
|
name | string |
ObsUnitResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Name
|
name | string | |
|
Pfad
|
path | string | |
|
Anzeigename
|
displayName | string |
Der Anzeigename wird auf die gleiche Weise gerendert wie auf der Benutzeroberfläche der Meisterplan-Anwendung. |
|
Übergeordnete ID
|
parentId | string |
CalendarResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Name
|
name | string | |
|
Übergeordnete ID
|
parentId | string | |
|
Pfad
|
path | string | |
|
Arbeitszeit
|
workingHours | WorkingHoursResponse |
WorkingHoursResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Monday
|
monday | double | |
|
Tuesday
|
tuesday | double | |
|
Wednesday
|
wednesday | double | |
|
Thursday
|
thursday | double | |
|
Friday
|
friday | double | |
|
Saturday
|
saturday | double | |
|
Sonntag
|
sunday | double |
Mauszeiger
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Mauszeiger
|
cursor | string |
Paginierung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Mauszeiger
|
after | Cursor |
BasicUserGroupResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gruppen-ID
|
id | string |
ID einer Benutzergruppe. |
|
Gruppenname
|
name | string |
Name einer Benutzergruppe. |
LinkedResourceResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID der verknüpften Ressource. |
|
Ressourcenschlüssel
|
resourceKey | string |
Ressourcenschlüssel der verknüpften Ressource. |
PaginatedResponseUserResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of UserResponse | |
|
Paginierung
|
_pagination | Pagination |
UserResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Nutzername
|
userName | string | |
|
Externe ID
|
externalId | string | |
|
Active
|
active | boolean | |
|
E-Mail-Adresse
|
emailAddress | string | |
|
Nachname
|
lastName | string | |
|
Vorname
|
firstName | string | |
|
Anzeigename
|
displayName | string | |
|
Gebietsschema
|
locale | string | |
|
Gruppen
|
groups | array of BasicUserGroupResponse | |
|
Letzte Anmeldung
|
lastLogin | date-time | |
|
E-Mail bestätigt
|
emailVerified | boolean | |
|
Verknüpfte Ressource
|
linkedResource | LinkedResourceResponse | |
|
Kennwort läuft nie ab
|
passwordNeverExpires | boolean |
SprintResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Sprintschlüssel
|
key | string | |
|
Name
|
name | string | |
|
Start
|
start | date-time | |
|
ENDE
|
end | date-time |
ListResponseScenarioResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of ScenarioResponse |
ScenarioResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Name
|
name | string |
ListResponseRoleWithRoleCapacityResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of RoleWithRoleCapacityResponse |
RoleWithRoleCapacityResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Rollen-ID
|
roleId | string |
Die ROLLEN-ID. |
|
segments
|
segments | array of RoleCapacityResponse |
Die Kapazitätssegmente der Rolle. |
ListResponseMilestoneResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of MilestoneResponse |
ListResponseFinancialsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of FinancialsResponse |
ListResponseFinancialActualsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of FinancialActualsResponse |
PaginatedResponseProjectCommentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of ProjectCommentResponse | |
|
Paginierung
|
_pagination | Pagination |
ProjectCommentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Content
|
content | string | |
|
Benutzer ref
|
author | UserRefResponse | |
|
Erstellt am
|
createdDate | string | |
|
Erwähnungen
|
mentions | array of UserRefResponse |
ListResponseAllocationResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of AllocationResponse |
AllocationCommentEntityResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der Entität, mit der dieser Zuordnungskommentar verknüpft ist |
|
Typ
|
type | string |
Der Typ der Entität, mit der dieser Zuordnungskommentar verknüpft ist |
AllocationCommentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Content
|
content | string | |
|
Benutzer ref
|
author | UserRefResponse | |
|
Erstellt am
|
createdDate | string | |
|
Erwähnungen
|
mentions | array of UserRefResponse | |
|
Zugeordnete Entität
|
allocatedEntity | AllocationCommentEntityResponse |
PaginatedResponseAllocationCommentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of AllocationCommentResponse | |
|
Paginierung
|
_pagination | Pagination |
PaginatedResponseActualTimeWorkedResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of ActualTimeWorkedResponse | |
|
Paginierung
|
_pagination | Pagination |
ActualTimeWorkedByIdResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Actuals-Entitätslink
|
bookedEntity | ActualsEntityLinkResponse | |
|
Id
|
id | string |
Buchungs-ID dieses tatsächlich geleisteten Zeiteintrags |
|
Buchungsdatum
|
bookingDate | date |
Buchungsdatum dieses tatsächlichen Arbeitstermins |
|
Stunden
|
hours | double |
Ist-Zeit in Stunden gearbeitet |
|
Kostenart
|
costType | string | |
|
Kosten pro Stunde
|
costPerHour | double |
PaginatedResponseProgramGetAllResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of ProgramGetAllResponse | |
|
Paginierung
|
_pagination | Pagination |
ProgramGetAllResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Name
|
name | string | |
|
Programmschlüssel
|
programKey | string |
Muss eindeutig sein. Wenn leer, wird der Wert generiert. |
MilestoneDependencyResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Meilensteinreferenz
|
from | MilestoneReferenceResponse | |
|
Meilensteinreferenz
|
to | MilestoneReferenceResponse |
MilestoneReferenceResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Projektkennung
|
projectId | string | |
|
Meilenstein-ID
|
milestoneId | string |
PaginatedResponseMilestoneDependencyResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of MilestoneDependencyResponse | |
|
Paginierung
|
_pagination | Pagination |
ListResponseAbsenceResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of AbsenceResponse |
ListResponsePortfolioResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of PortfolioResponse |
PortfolioResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string | |
|
Name
|
name | string |
ListResponseObsTypeResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of ObsTypeResponse |
ListResponseObsUnitResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of ObsUnitResponse |
ListResponseCalendarResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of CalendarResponse |
CalendarExceptionResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datum
|
date | date | |
|
Arbeitszeit
|
workingHours | double | |
|
Description
|
description | string | |
|
Quellkalender-ID
|
sourceCalendarId | string |
ListResponseCalendarExceptionResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of CalendarExceptionResponse |
BusinessGoalDefinitionResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
name | string | |
|
subGoals
|
subGoals | array of SubGoalDefinitionResponse |
ListResponseBusinessGoalDefinitionResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
items | array of BusinessGoalDefinitionResponse |
SubGoalDefinitionResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
name | string | |
|
Anzeigename
|
displayName | string |