Articles in this section

See more

API Endpoint: Project

Philipp Riermeier
  • Updated
Follow

Introduction

Projects are the overarching objects in smenso, where all project management processes take place. 

The project endpoint allows the addition of projects to the system. A project is defined by various attributes that are 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. Learn more about headers.

This documentation provides information about the API endpoint project. Developers can use this information to integrate projects from other sources into the system and retrieve the status of the processing.

 

Endpoint

**POST** `https://WORKSPACENAME.smenso.cloud/skyisland/api/Integration/project`

 

Note

The POST command can be used both to create new projects and to update existing projects. If a GUID of a project is specified in the XML, this project is updated. If no GUID is specified in the XML, a new project is created.

 

Fields

Name Type Description
Id GUID The GUID of the project
Benefit string The Project Benefit field from the project master data
Budget double The Budget field from the project master data
DepartmentId integer  
Description

string

Additionally use CDATA if HTML

Example:

<![CDATA[Description]]>

Allowed Tags: "h1", "br", "ul", "li", "a", "b", "p", "h2", "h3", "h4", "h5"

Allowed Attributes: "href"

 The Description field of the project
StartDate string <date> The Project Start field from the project master data
EndDate string <date> The Project End field from the project master data
Goal string The Project Goal field from the project master data
LocationId* integer The Location field from the project master data. The LocationId can be accessed via a flavor of type "Formula"*.
PhaseId* integer The Project Folder field from the project master data. The PhaseId can be accessed via a flavor of type "Formula"*.
ProjectManager GUID The Project Manager field from the project master data
Title string The title of the project
TypeId* integer The Project Type field from the project master data. The TypeId can be accessed via a flavor of type "Formula"*.
WorkflowId GUID The GUID of a custom workflow that is defined in the project master data as the default for tasks.
TaskTemplateId GUID The GUID of the task template that is defined as default in the project master data.
LogoDocumentId GUID The GUID of the logo used for print outputs and defined in the project master data.
Private

GUID,GUID,GUID,...

(from people)

 The comma-separated GUIDs of people who are authorized in the private project.
TempId

string

This is not a database field. 

It is used for the assignment of the GUID of the created elements to the element in the call.

The result is then delivered in the request ticket. The GUID will only be delivered in the result ticket for elements with TempId.

 

*Additions:

  • The LocationId can be accessed via a flavor of type "Formula" (small 'l', capital 'I'):
  • The PhaseId can be accessed via a flavor of type "Formula" (small 'f', capital 'I'):
  • The TypeId can be accessed via a flavor of type "Formula" (small 't', capital 'I'):

 

Request Data

This is an example request in XML format:

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

 

Response

After successful execution, you will receive a Ticket ID (e.g. `c3406426-6028-48da-ad4a-76865336ff0f`), which can be used to check the status later.

 

Retrieve Ticket Status

Description

To be able to check the status of the request, the returned Ticket ID can be checked in a separate call.

 

Endpoint

You can retrieve the status of a ticket at the following endpoint:

**GET** `https://WORKSPACENAME.smenso.cloud/skyisland/api/integration/status/{ticket-id}`

 

Response (Example)

The response contains detailed information about the status of the ticket and the number of created and modified projects and tasks.

<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 OF CREATED PROJECT]]]>
      </Message>
    </Messages>
</Ticket>

 

 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.