Einleitung
Der Endpunkt ermöglicht das Hinzufügen eines Statusberichts basierend auf einer Statusberichtvorlage.
Das Hinzufügen von Statusberichten basierend auf einer Statusberichtvorlage 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/statusreport/create/{templateId}
(Geschweifte Klammern nach Einfügen der templateid entfernen)
Felder
Die folgenden Felder können bei der Anlage eines Statusberichts aus einer Statusberichtvorlage über die smenso API angesprochen werden.
| Name | Typ | Beschreibung |
|---|---|---|
| TemplateId | GUID |
Die GUID der Statusberichtvorlage (in der Endpunkt-URL anzugeben). Die TemplateId lässt sich wie folgt herausfinden:
|
| ProjectId* | GUID |
(Pflicht-Parameter) Die GUID des Projekts, auf das die Statusberichtvorlage angewendet werden soll. |
| Title* | string |
(Pflicht-Parameter) Der Titel des Statusberichts |
| ProgressManual* | Double |
(Pflicht-Parameter) Das Feld |
Anfragedaten
Die Anfrage enthält Informationen für das Hinzufügen eines Statusberichts basierend auf einer Statusberichtsvorlage im XML-Format. Alle sonstigen Felder werden von der Statusberichtsvorlage übernommen.
Beispiel:
<create>
<Base>
<ProjectId>a6a74aea-1f45-4b10-8477-9476ca3f6903</ProjectId> <!--Pflichtparameter-->
<Title>Statusbericht</Title> <!--Pflichtparameter-->
<ProgressManual>5</ProgressManual> <!--Pflichtparameter-->
</Base>
</create>
Hinweis
Über die API angelegte Statusberichte werden im Entwurfsstatdium angelegt.
Antwort
Nach erfolgreicher Ausführung wird folgende Meldung ausgegeben, inklusive der StatusReportId des angelegten Statusberichts:
<Result>
<HasErrors>false</HasErrors>
<StatusReportId>2919899c-69a9-4ccb-9844-7b3e790570ad</StatusReportId>
</Result>
Bei fehlerhafter Ausführung werden Details zum Fehler zurückgegeben, z.B.
<Result>
<HasErrors>true</HasErrors>
<Errors>
<ErrorDetail>Can't add a new status report, because a draft is pending for project a6a74aea-1f45-4b10-8477-9476ca3f6903.</ErrorDetail>
</Errors>
</Result>
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.