Create/update status report from a template

This POST endpoint creates a status report based on a template and transfers all supported fields, including RichText content, from the template into the new report. The report is generated with the current publication date, and once published, it can no longer be modified.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Body Fields

The following fields can be addressed when creating a status report from a status report template via the smenso API.

NameTypeDescription
TemplateIdGUID

The GUID of the status report template (to be specified in the endpoint URL).

How to find the TemplateId:

Open the menu to browse status report templates
Click on the 3-dot menu of a template in the browse dialog or (alternatively) open a status report template
Click Copy GUID

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 Progress level field from the status report, indicated as a percentage.

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.

<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>

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>


Path Params
string
required
Responses
200

OK

401

Unauthorized

403

Forbidden

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!