Einleitung
Projekte sind die übergeordneten Objekte in smenso, in denen alle Projektmanagement-Prozesse ablaufen.
Der project-Endpunkt ermöglicht das Hinzufügen oder Aktualisieren von Projekten in das System. Ein Projekt wird durch verschiedene Attribute definiert, die im XML-Format in der Anfrage übermittelt werden.
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.
Diese Dokumentation bietet Informationen zum API-Endpunkt project. Entwickler:innen können diese Informationen nutzen, um Projekte von anderen Quellen in das System zu integrieren und den Status der Verarbeitung abzurufen.
Endpunkt
**POST** `https://WORKSPACENAME.smenso.cloud/skyisland/api/Integration/project`
Hinweis:
Mit dem POST-Befehl können sowohl Projekte neu angelegt werden, als auch bestehende Projekte aktualisiert werden. Wenn eine GUID eines Projekts im XML angegeben wird, wird dieses Projekt aktualisiert. Wenn keine GUID im XML angegeben wird, wird ein neues Projekt angelegt.
Felder
| Name | Typ | Beschreibung |
|---|---|---|
| Id | GUID |
Die GUID des Projekts
Hinweis: Wenn keine GUID angegeben wird, wird ein neues Projekt angelegt. Wenn eine GUID angegeben wird, wird das betreffende Projekt aktualisiert. |
| Benefit | string | Das Feld Projektnutzen aus den Projektstammdaten |
| Budget | double | Das Feld Budget aus den Projektstammdaten |
| DepartmentId | integer | nicht mehr unterstützt |
| Description |
string Zusätzlich CDATA verwenden, wenn HTML Beispiel: <![CDATA[Beschreibung]]> Erlaubte Tags: "h1", "br", "ul", "li", "a", "b", "p", "h2", "h3", "h4", "h5" Erlaubte Attribute: "href" |
Das Feld Beschreibung des Projekts |
| StartDate | string <date> | Das Feld Projektstart aus den Projektstammdaten |
| EndDate | string <date> | Das Feld Projektende aus den Projektstammdaten |
| Goal | string |
Das Feld |
| LocationId* | integer |
Das Feld Die LocationId kann über einen Flavor vom Typ "Formel" aufgerufen werden*. |
| PhaseId* | integer |
Das Feld Die PhaseId kann über einen Flavor vom Typ "Formel" aufgerufen werden*. |
| ProjectManager | GUID | Das Feld Projektleitung aus den Projektstammdaten |
| Title | string |
Der Titel des Projekts |
| TypeId* | integer |
Das Feld Die TypeId kann über einen Flavor vom Typ "Formel" aufgerufen werden.* |
| WorkflowId | GUID | Die GUID eines benutzerdefinierten Workflows, der in den Projektstammdaten als Standard für Aufgaben definiert wird. |
| TaskTemplateId | GUID | Die GUID der Aufgabenvorlage, die standardmäßig in den Projektstammdaten definiert wird. |
| LogoDocumentId | GUID | Die GUID des Logos, das für Druckausgaben verwendet wird und in den Projektstammdaten definiert wird. |
| Private |
GUID,GUID,GUID,... (von Personen) |
Die kommagetrennten GUIDs von Personen, die im privat gesetzten Projekt berechtigt sind. |
| TempId |
string |
Dies ist kein Datenbankfeld. Es wird nur für die Zuordnung der GUID der erstellten Elemente zu dem Element im Aufruf verwendet. Das Ergebnis wird dann im zurückgelieferten Ticket geliefert. Die GUID wird im Ergebnisticket nur für Elemente mit TempId geliefert. |
*Ergänzungen:
- Die LocationId kann über einen Flavor vom Typ "Formel" aufgerufen werden (kleines 'l', großes 'I'):
- Die PhaseId kann über einen Flavor vom Typ "Formel" aufgerufen werden (kleines 'f', großes 'I'):
- Die TypeId kann über einen Flavor vom Typ "Formel" aufgerufen werden (kleines 't', großes 'I'):
Anfragedaten
Beispiel-XML für einen API-Anfrage:
<Projects>
<Project>
<Id>project-guid</Id>
<Title><![CDATA[Titel des Projekts]]></Title>
<Start>3.5.2023 +2</Start>
<End>9.5.2023 +2</End>
<Description><![CDATA[Beschreibung des Projekts]]></Description>
<TypeId>7</TypeId>
<FolderId>1</FolderId>
<LocationId>1017</LocationId>
<Private>person-guid,person-guid</Private>
</Project>
</Projects>
Antwort
Nach erfolgreicher Ausführung erhalten Sie eine Ticket ID (z. B. `c3406426-6028-48da-ad4a-76865336ff0f`), die zur späteren Überprüfung des Status verwendet wird.
Ticket-Status abrufen
Beschreibung
Um den Status der Anlage überprüfen zu können, kann man die zurückgelieferte Ticket ID in einem separaten Aufrufen überprüfen.
Endpunkt
Du kannst den Status eines Tickets unter folgendem Endpunkt abrufen:
**GET** `https://WORKSPACENAME.smenso.cloud/skyisland/api/Integration/status/{ticket-id}`
Antwort (Beispiel)
Die Antwort enthält detaillierte Informationen über den Status des Tickets und die Anzahl der erstellten und modifizierten Projekte und Aufgaben.
<Ticket>
<Id>c3537862-8b5c-4801-9992-e21764b26239</Id>
<Endpoint>Project</Endpoint>
<Success>1</Success>
<Status>Success</Status>
<StatusId>10</StatusId>
<Received>08/21/2024 14:47:57 +00:00</Received>
<Started>08/21/2024 14:47:59 +00:00</Started>
<Processed>08/21/2024 14:48:01 +00:00</Processed>
<Projects>
<Created>1</Created>
<Modified>0</Modified>
<AttributesModified>0</AttributesModified>
</Projects>
<Tasks>
<Created>0</Created>
<Modified>0</Modified>
<AttributesModified>0</AttributesModified>
<FoldersCreated>0</FoldersCreated>
</Tasks>
<Messages>
<Message>
<![CDATA[[PROJECT CREATED][d986f4d0-2b84-4368-a8c8-73eed1b64e5b][NAME DES ERSTELLTEN PROJEKTS]]]>
</Message>
</Messages>
</Ticket>
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.