XP-Dev.com Documentation

Old Tasks API

This user guide only applies if your account and project is on our old platform, i.e. if your project's URL begins with https://xp-dev.com rather than https://<your-account>.xp-dev.com. If your account is on our new platform, you should be using this user guide instead.

Each Task Object has the following attributes:

Attribute Description
id Unique Task ID
description Task description in Textile
descriptionHtml Task description in HTML
assignedTo Username that the Task is assigned to
story Story ID that the Task belongs to
completed Whether the Task is completed or not
estimatedTime Tasks’s estimated time
displayId Tasks’s artifact ID

List All Tasks for a Story

GET request to https://xp-dev.com/api/v1/tasks/story/<story-id>:

curl https://xp-dev.com/api/v1/tasks/story/3

Responses will be a list of Task Objects:

{"response":[ { "id":2, "description":"change some code", "completed":false, "estimatedTime":10.0, "story":4, "assignedTo":"developer", "displayId":15, "htmlDescription":"

change some code

" }, ... ]}

List All Tasks for a Project

GET request to https://xp-dev.com/api/v1/tasks/project/<project-id>:

curl https://xp-dev.com/api/v1/tasks/project/3

Responses will be a list of Task Objects.

Create a New Task

POST request to https://xp-dev.com/api/v1/tasks/ with the following attributes:

Mandatory:

  • story
  • description
  • estimatedTime
  • completed

Optional:

  • assignedTo

Example request:

curl -X POST -H 'Content-Type: application/json' -d '{"description":"change some code","completed":false,"estimatedTime":10.0,"story":4,"assignedTo":"developer"}' https://xp-dev.com/api/v1/tasks/

Responses will be in the form of a single Task Object

Get a Single Task

GET request to https://xp-dev.com/api/v1/tasks/<task-id>. For example:

curl https://xp-dev.com/api/v1/tasks/6

Responses will be in the form of a single Task Object

Update a Single Task

PUT request to https://xp-dev.com/api/v1/tasks/<task-id> with the following attributes:

Mandatory:

  • story
  • description
  • estimatedTime
  • completed

Optional:

  • assignedTo

Example request:

curl -X PUT -H 'Content-Type: application/json' -d '{"description":"change some code","completed":true,"estimatedTime":10.0,"story":4,"assignedTo":"developer"}' https://xp-dev.com/api/v1/tasks/6

Responses will be in the form of a single Task Object

Delete a Single Task

DELETE request to https://xp-dev.com/api/v1/tasks/<tasks-id>:

curl -X DELETE https://xp-dev.com/api/v1/tasks/6

Task Metrics

Each Task Metrics Object has the following attributes:

Attribute Description
hours Total number of hours estimated, added, remaining and percentage completion

Get Metrics for a Single Task

GET request to https://xp-dev.com/api/v1/tasks/metrics/<task-id>:

curl https://xp-dev.com/api/v1/tasks/metrics/6

Responses will be an Task Metrics Object:

{"response":{
    "hours":{
        "total":10.0,
        "remaining":9.0,
        "added":7.0,
        "completion":70.0
    }
}}

Feel free to contact us if you need any assistance.