Introduction
The endpoint allows adding a status report based on a status report template.
Adding status reports based on a status report template is defined by various attributes that can be sent in XML format in the request.
Each endpoint requires the use of a personalized token, which can be obtained from the Admin Center and must be set in the header. More information about the header.
Endpoint
**POST** `https://WORKSPACENAME.smenso.cloud/skyisland/api/integration/template/statusreport/create/{templateId}
(Remove curly brackets after inserting the templateid)
Fields
The following fields can be addressed when creating a status report from a status report template via the smenso API.
Name | Type | Description |
---|---|---|
TemplateId | GUID |
The GUID of the status report template (to be specified in the endpoint URL). How to find the TemplateId:
|
ProjectId* | GUID |
(Required parameter) The GUID of the project to which the status report template should be applied. |
Title* | string |
(Required parameter) The title of the status report |
ProgressManual* | Double |
(Required parameter) The |
Request Data
The request contains information for adding a status report based on a status report template in XML format. All other fields are inherited from the status report template.
Example:
<create>
<Base>
<ProjectId>a6a74aea-1f45-4b10-8477-9476ca3f6903</ProjectId> <!--Required parameter-->
<Title>Status report</Title> <!--Required parameter-->
<ProgressManual>5</ProgressManual> <!--Required parameter-->
&
nbsp;</Base>
</create>
Note
Status reports created via the API are saved in draft mode.
Response
After successful execution, the following message is returned, including the StatusReportId of the created status report:
<Result>
<HasErrors>false</HasErrors>
<StatusReportId>2919899c-69a9-4ccb-9844-7b3e790570ad</StatusReportId>
</Result>
In case of an error, details of the error will be returned, e.g.
<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>
```
Comments
0 comments
Please sign in to leave a comment.