All docs This doc
Skip to end of metadata
Go to start of metadata


Overview

The following operations allow you to work with tasks. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with tasks, see Sample configuration

OperationDescription

createTask

Creates a task in the specified story.

getTaskRetrieves a single task from the specified story.
listTasksRetrieves the list of tasks from the specified story.
updateTaskModifies a single task in the specified story.

Operation details

This section provides further details on the operations related to tasks.

Creating a task in the specified story

The createTask operation creates a task in the specified story.

createTask
<agilezen.createTask>
    <storyId>{$ctx:storyId}</storyId>
    <projectId>{$ctx:projectId}</projectId>
    <text>{$ctx:text}</text>
	<status>{$ctx:status}</status>
</agilezen.createTask>
Properties
  • storyId: The ID of the story to which the task belongs.
  • projectId: The ID of the project to which the story belongs.
  • text: The text of the task.
  • status: The status of the task. Either complete or incomplete.
   Sample request

Following is a sample REST/JSON request that can be handled by the createTask operation.

Sample Request for createTask
{
  
    "apiUrl": "https://agilezen.com",
    "apiKey": "7fb8d03c21d748e09fb31b62b1ba7d13",
    "format": "json",
    "storyId": 1,
    "projectId": 70025,
    "text": "Description for Task 0001",
    "status": "incomplete"

}

Note

There are optional parameters available. For more information on the usage of these parameters please check the API document. 

Related AgileZen documentation

http://dev.agilezen.com/resources/tasks.html#create_a_new_task

Retrieving a single task from the specified story

The getTask operation retrieves a single task from the specified story.

getTask
<agilezen.getTask>
    <taskId>{$ctx:taskId}</taskId>
    <storyId>{$ctx:storyId}</storyId>
	<projectId>{$ctx:projectId}</projectId>
</agilezen.getTask>
Properties
  • taskId: The ID of the task whose details would be retrieved.
  • storyId: The ID of the story to which the task belongs.
  • projectId: The ID of the project to which the story belongs.
   Sample request

Following is a sample REST/JSON request that can be handled by the getTask operation.

Sample Request for getTask
{
    "apiUrl": "https://agilezen.com",
    "apiKey": "7fb8d03c21d748e09fb31b62b1ba7d13",
    "format": "json",
    "taskId": 2290026,
    "storyId": 1,
    "projectId": 70025
}

Note

There are optional parameters available. For more information on the usage of these parameters please check the API document. 

Related AgileZen documentation

http://dev.agilezen.com/resources/tasks.html#get_a_task

Retrieving the list of tasks from the specified story

The listTasks operation retrieves the list of tasks from the specified story.

listTasks
<agilezen.listTasks>
    <storyId>{$ctx:storyId}</storyId>
    <projectId>{$ctx:projectId}</projectId>
    <filters>{$ctx:filters}</filters>
    <page>{$ctx:page}</page>
	<pageSize>{$ctx:pageSize}</pageSize>
</agilezen.listTasks>
Properties
  • storyId: The ID of the story to which the tasks belong.
  • projectId: The ID of the project to which the story belongs.
  • filters: Filter queries which the user can use to filter the returned data.
  • page: The number of the page to be returned when response is paginated.
  • pageSize: The number of responses to be returned in a call when response is paginated.
   Sample request

Following is a sample REST/JSON request that can be handled by the listTasks operation.

Sample Request for listTasks
{
    "apiUrl": "https://agilezen.com",
    "apiKey": "7fb8d03c21d748e09fb31b62b1ba7d13",
    "format": "json",
    "storyId": 1,
    "projectId": 70025,
    "page": 1,
    "pageSize": 4
}

Note

There are optional parameters available. For more information on the usage of these parameters please check the API document. 

Related AgileZen documentation

http://dev.agilezen.com/resources/tasks.html#list_tasks_within_a_story

Modifying a single task in the specified story

The updateTask operation modifies a single task in the specified story.

updateTask
<agilezen.updateTask>
    <taskId>{$ctx:taskId}</taskId>
    <storyId>{$ctx:storyId}</storyId>
    <projectId>{$ctx:projectId}</projectId>
    <text>{$ctx:text}</text>
	<status>{$ctx:status}</status>
</agilezen.updateTask>
Properties
  • taskId: The ID of the task to update.
  • storyId: The ID of the story to which the task belongs.
  • projectId: The ID of the project to which the story belongs.
  • text: The text of the task.
  • status: The status of the task. Either complete or incomplete.
   Sample request

Following is a sample REST/JSON request that can be handled by the updateTask operation.

Sample Request for updateTask
{

    "apiUrl": "https://agilezen.com",
    "apiKey": "7fb8d03c21d748e09fb31b62b1ba7d13",
    "format": "json",
    "taskId": 2290026,
    "storyId": 1,
    "projectId": 70025,
    "text": "Description for Task 0001",
    "status": "incomplete"

}

Note

There are optional parameters available. For more information on the usage of these parameters please check the API document. 

Related AgileZen documentation

http://dev.agilezen.com/resources/tasks.html#update_a_task

Sample configuration

Following is a sample proxy service that illustrates how to connect to AgileZen with the init operation and use the createTask operation. The sample request for this proxy can be found in the createTask sample request.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="agilezen_createTask" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="apiKey" expression="json-eval($.apiKey)"/>
         <property name="format" expression="json-eval($.format)"/>
         <property name="storyId" expression="json-eval($.storyId)"/>
         <property name="enrichments" expression="json-eval($.enrichments)"/>
         <property name="projectId" expression="json-eval($.projectId)"/>
         <property name="text" expression="json-eval($.text)"/>
         <property name="status" expression="json-eval($.status)"/>
         <agilezen.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <apiKey>{$ctx:apiKey}</apiKey>
            <format>{$ctx:format}</format>
            <enrichments>{$ctx:enrichments}</enrichments>
         </agilezen.init>
         <agilezen.createTask>
            <storyId>{$ctx:storyId}</storyId>
            <projectId>{$ctx:projectId}</projectId>
            <text>{$ctx:text}</text>
            <status>{$ctx:status}</status>
         </agilezen.createTask>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>
  • No labels