Einleitung
Der Endpunkt ermöglicht das Hinzufügen von Projekten basierend auf einer Projektvorlage.
Das Hinzufügen von Projekten über eine Projektvorlage wird durch verschiedene Attribute definiert, die im XML-Format in der Anfrage übermittelt werden können.
Jeder Endpunkt erfordert die Verwendung eines personalisierten Tokens, der aus dem Admin Center bezogen werden kann und im Header gesetzt werden muss. Mehr Informationen zum Header.
Endpunkt
**POST** `https://WORKSPACENAME.smenso.cloud/skyisland/api/Integration/template/project/create/{templateId}`
(Geschweifte Klammern nach Einfügen der templateid entfernen)
Felder
Die folgenden Felder können bei der Projektanlage aus einer Projektvorlage über die smenso API angesprochen werden.
Hauptfelder
| Name | Typ | Beschreibung |
|---|---|---|
| TemplateId | GUID | Die GUID der Projektvorlage (in der Endpunkt-URL zu verwenden) |
| IsPrivate | boolean |
Bestimmt, ob das Projekt privat angelegt wird oder öffentlich. IsPrivate = true bedeutet, das Projekt wird privat angelegt. IsPrivate = false bedeutet, das Projekt wird öffentlich angelegt.
Hinweis: Wenn hier true ausgewählt wird, wird standardmäßig die Person im privaten Projekt berechtigt, die das Projekt per API angelegt hat. Es muss in einem nächsten Schritt über den Project Endpunkt bestimmt werden, welche sonstigen Personen in der UI noch Zugriff auf das private Projekt haben sollen. |
| Title* | string |
(Pflicht-Parameter) Der Titel des Projekts |
| StartDate | string <date> |
Wenn dem anzulegenden Projekt ein neues Startdatum vergeben werden soll (Feld Wenn leer, wird das Startdatum aus der Vorlage übernommen. |
| StatusId | integer |
Bestimmt, ob das Projekt "inaktiv" oder "aktiv" angelegt wird. StatusId 1 = inaktiv StatusId 0 = aktiv |
| ProjectType* | string |
(Pflicht-Parameter) Das Feld
Hinweis: Es kann der Name des Projekttyps verwendet werden, dieser wird aufgelöst in das Feld TypeId. |
| Folder* | string |
(Pflicht-Parameter) Das Feld
Hinweis: Es kann der Name des Projektordners verwendet werden, dieser wird aufgelöst in das Feld PhaseId. |
| Code | string | Das Feld Projekt ID aus den Projektstammdaten. |
Optionale Felder
Im Projektanlage-Assistent besteht optional die Möglichkeit, einzelne Projektstammdaten nicht aus der Projektvorlage zu übernehmen. Diese Checkboxen können in der Benutzeroberfläche an- und abgewählt werden. Standardmäßig sind alle Checkboxen aktiv, d.h. alle Werte werden von der Projektvorlage übernommen.
Gleichermaßen verhält es sich bei der Anlage eines Projekts mit Projektvorlage über die API.
Alle optionalen Felder sind vom Typ boolean und haben Standardwerte (true/false). Sie müssen nur in der Anfrage angegeben werden, wenn ein anderer Wert als der Standardwert angegeben werden soll.
| AdjustTaskDates | boolean |
Checkbox im Projektanlage-Assistent, um festzulegen, ob Aufgabentermine an das neue Startdatum angepasst werden sollen: Standardwert: True |
| Tasks | boolean |
Checkbox zur Auswahl, ob Aufgaben aus der Projektvorlage übernommen werden sollen. Standardwert: True |
| Flavors | boolean |
Checkbox zur Auswahl, ob (Projektstammdaten-)Flavors aus der Projektvorlage übernommen werden sollen. Standardwert: True |
| Labels | boolean |
Checkbox zur Auswahl, ob (Projektstammdaten-)Labels aus der Projektvorlage übernommen werden sollen. Standardwert: True |
| Manager | boolean |
Checkbox zur Auswahl, ob das Feld Standardwert: True |
| TasksWorkflow | boolean |
Der benutzerdefinierte Workflow, der in den Projekteinstellungen als Standard für Aufgaben definiert wird. Standardwert: True |
| TasksTemplate | boolean |
Die Aufgabenvorlage, der in den Projekteinstellungen als Standard für neue Aufgaben definiert wird. Standardwert: True |
| FolderTasksTemplate | boolean |
Die Aufgabenvorlage, die je Ordner in den Ordnereinstellungen als Standard für neue Aufgaben hinterlegt werden kann. Standardwert: True |
| ViewSettings | boolean |
Feld ist aktuell inaktiv / kann ignoriert werden. Vorbereitung für die Übernahme von Ansichten aus der Projektvorlage. |
| Budget | boolean |
Das Feld Standardwert: True |
| Location | boolean |
Das Feld Standardwert: True |
| Description | boolean |
Das Feld Standardwert: True |
| HourlyRate | boolean |
Das Feld Standardwert: True |
| Goal | boolean |
Das Feld Standardwert: True |
| Benefit | boolean |
Das Feld Standardwert: True |
| Observers | boolean |
Die Standardwert: True |
| Permissions | boolean |
Die Projekteinstellung Standardwert: True |
| BlockTimeRecording | boolean |
Das Toggle Standardwert: False |
| MarkedColumns | boolean |
Spaltenmarkierungen (Farbe/Status), die in Spalten des Projekts hinterlegt werden können. Standardwert: True |
| ColumnDescriptions | boolean |
Spaltenbeschreibungen, die in Spalten des Projekts hinterlegt werden können. Standardwert: True |
Anfragedaten
Die Anfrage enthält Informationen zur Anlage eines Projekts unter Verwendung einer Projektvorlage im XML-Format:
<create>
<ProjectBase>
<IsPrivate>false</IsPrivate>
<StartDate>0001-01-01T01:00:00+01:00</StartDate>
<StatusId>0</StatusId>
<Title /> <!-- Pflicht Parameter -->
<ProjectType></ProjectType> <!-- Pflicht Parameter -->
<Folder></Folder> <!-- Pflicht Parameter -->
<Code />
</ProjectBase>
<!-- Ab hier sind Angaben nur notwendig, wenn einer der Werte *nicht* aus der Vorlage übernommen werden soll. Standardmäßig werden alle Werte aus der Vorlage übernommen -->
<AdjustTaskDates>true</AdjustTaskDates>
<Tasks>true</Tasks>
<Flavors>true</Flavors>
<Labels>true</Labels>
<Manager>true</Manager>
<TasksWorkflow>true</TasksWorkflow>
<TasksTemplate>true</TasksTemplate>
<FolderTasksTemplate>true</FolderTasksTemplate>
<ViewSettings>true</ViewSettings>
<Budget>true</Budget>
<Location>true</Location>
<Description>true</Description>
<HourlyRate>true</HourlyRate>
<Goal>true</Goal>
<Benefit>true</Benefit>
<Observers>true</Observers>
<Permissions>true</Permissions>
<BlockTimeRecording>false</BlockTimeRecording>
<MarkedColumns>true</MarkedColumns>
<ColumnDescriptions>true</ColumnDescriptions>
</create>
Antwort
Nach erfolgreicher Ausführung wird direkt die ProjectID des angelegten Projekts zurückgegeben (z.B. a6862cba-5245-4af8-92b3-b43f12feb149).
<Result>
<HasErrors>false</HasErrors>
<ProjectId>a6862cba-5245-4af8-92b3-b43f12feb149</ProjectId>
</Result>
Bei fehlerhafter Ausführung werden Details zum Fehler zurückgegeben, z.B. aufgrund eines bereits existierenden Projekttitels...
<Result>
<HasErrors>true</HasErrors>
<Errors>
<ErrorDetail>A project with Title 'Preparing the Fall of Tom Riddle aka Lord Voldemort' already exists</ErrorDetail>
</Errors>
</Result>
...oder fehlenden Pflichtfeldangaben.
<Result>
<HasErrors>true</HasErrors>
<Errors>
<ErrorDetail>The field PhaseId must be between 1 and 2147483647.</ErrorDetail>
<ErrorDetail>The Title field is required.</ErrorDetail>
</Errors>
</Result>
Hinweis
Es existiert eine frühere Version dieses Endpunkts (.../Integration/template/createproject/{templateid}). Dieser wird bis auf weiteres weiterhin unterstützt, aber mittelfristig deaktiviert. Für neue Anfragen ist der obige Endpunkt zu verwenden.
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.