Introduction
The endpoint allows the updating of project master data in existing projects based on a project template.
Updating project master data via a project template is defined by various attributes that can be transmitted 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/project/updatemasterdata/{templateId}
(Remove the curly braces after inserting the template ID)
Fields
The following project master data fields can be applied from a project template to an existing project via the smenso API:
| Name | Type | Description |
|---|---|---|
| TemplateId* | GUID |
(Required Parameter) The GUID of the project template (to be specified in the endpoint URL) |
| ProjectId* | GUID |
(Required Parameter) The GUID of the project to which the project template should be applied. |
| OverwriteValues | boolean | Toggle selection to determine whether flavor values should be overwritten if values exist in the project template. |
| StartDate | boolean |
Start date of the project (project master data) |
| EndDate | boolean |
End date of the project (project master data) |
| Flavors | boolean | Flavors (including groups) from the project master data. |
| FlavorGroupsLockStatus | boolean | The lock status of flavor groups from the project master data. |
| Labels | boolean | Labels from the project master data. |
| Manager | boolean | The Project Manager field from the project master data. |
|
Budget |
boolean | The Budget field from the project master data. |
| Location | boolean | The Location field from the project master data. |
| Description | boolean |
The |
| Goal | boolean | The Project Goal field from the project master data. |
| Benefit | boolean |
The |
| Icon | boolean | The project icon from the project master data. |
| Files | boolean | Attached files from the project master data. |
Request Data
The request contains information for updating the project master data of a project using a project template in XML format.
All parameters are set to false in the example below, meaning they do not need to be specified if they are not to be imported (i.e., set to true).
<Updatemasterdata>
<ProjectId></ProjectId> <!-- Required parameter -->
<OverwriteValues>false</OverwriteValues>
<StartDate>false</StartDate>
<EndDate>false</EndDate>
<Flavors>false</Flavors>
<FlavorGroupsLockStatus>false</FlavorGroupsLockStatus>
<Labels>false</Labels>
<Manager>false</Manager>
<Budget>false</Budget>
<Location>false</Location>
<Description>false</Description>
<Goal>false</Goal>
<Benefit>false</Benefit>
<Icon>false</Icon>
<Files>false</Files>
</Updatemasterdata>
Response
Upon successful execution, the following message will be displayed:
<Result>
<HasErrors>false</HasErrors>
<TemplateApplied>true</TemplateApplied>
</Result>
If the execution fails, details of the error will be returned, e.g.,
<Result>
<HasErrors>true</HasErrors>
<Errors>
<ErrorDetail>A template with Id '73669f07-07d5-4f3f-b462-5f0bf23389a' doesn't exist</ErrorDetail>
</Errors>
</Result>
Comments
0 comments
Please sign in to leave a comment.