API Endpoint: Task

Introduction

Tasks are versatile objects in smenso and can be used for various purposes. They are a central element within projects. 

The task endpoint allows the addition of tasks to a specific project. Tasks are defined by various attributes and must be associated with the relevant project.

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 task. Developers can use this information to integrate tasks from other sources into the system and retrieve the status of the processing.

Endpoint

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

Fields

Request Data (Example)

The request contains a list of tasks in the following XML format:

<Tasks projectId="project-guid">
<Task>
<Id>task-guid</Id>
<Title><![CDATA[Titel der Aufgabe]]></Title>
<Timezone>
<Description><![CDATA[Beschreibung der Aufgabe]]></Description>
<Priority>1</Priority>
<StartDate>04.05.2022 +02:00</StartDate>
<DueDate>18.5.2022 +2:00</DueDate>
<PlannedCost>200</PlannedCost>
<Cost>100</Cost> 
<StatusId>1</StatusId>
<WorkflowId>workflow-guid</WorkflowId>
<WorkflowStatusId>workflow-status-guid</WorkflowStatusId>
<Duration>120</Duration>
<PlannedDuration>180</PlannedDuration>
<IsMilestone>True</IsMilestone>
<Folder>Folder-name</Folder>
</Task>
</Tasks>

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.

Addressing Subtasks

<Tasks projectId=...>
<Task>
...
<Subtasks>
<Task>
...
</Task>
<Task>
...
</Task>
</Subtasks>
</Task>
</Tasks>

Using Flavors in Requests

Flavors are individual in each workspace. To address them via the API, you can use either the GUID (a globally unique ID with specific formatting) or the name of the flavor.

More information about the Flavor-GUID: Where can I get a Flavor-GUID?

The syntax for using the GUID or the flavor name in a request is as follows:

<Flavor target="GUID oder Name">Wert</Flavor>

Request Data (Example Data):

<Tasks projectId="e7737f60-d5a8-4b61-8cda-2ad51ccff4dd">
<Task>
<Id>567ed2e2-4eba-4c4d-aadd-97b8778ea98e</Id>
<Flavor target="f5a7dbd8-b3dc-4e51-99a6-385846823311">PHRI</Flavor>
<Flavor target="fa44bc82-30a9-4eb9-a343-f5b7f0a9c269">Objektplanung</Flavor>
</Task>
</Tasks>

Retrieving Ticket Status

Description

To check the status of the creation, you can check the Ticket ID in a separate call.

Request Data

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

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

Response

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

<Ticket>
<Id>c3406426-6028-48da-ad4a-76865336ff0f</Id>
<Endpoint>Task</Endpoint>
<Success>1</Success>
<Status>Success</Status>
<StatusId>10</StatusId>
<Received>05/10/2022 09:53:49 +00:00</Received>
<Started>05/10/2022 09:53:52 +00:00</Started>
<Processed>05/10/2022 09:56:41 +00:00</Processed>
<Projects>
<Created>0</Created>
<Modified>0</Modified>
<AttributesModified>0</AttributesModified>
</Projects>
<Tasks>
<Created>100</Created>
<Modified>0</Modified>
<AttributesModified>0</AttributesModified>
</Tasks>
</Ticket>