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


Overview

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

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

OperationDescription

getProject

Retrieves a single project.

listProjectsRetrieves the list of projects.
updateProjectModifies a single project.

Operation details

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

Retrieving a single project 

The getProject operation retrieves a single project.

getProject
<agilezen.getProject>
	<projectId>{$ctx:projectId}</projectId>
</agilezen.getProject>
Properties
  • projectId: The ID of the project whose details would be retrieved.
   Sample request

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

Sample Request for getProject
{
    "apiUrl": "https://agilezen.com",
    "apiKey": "7fb8d03c21d748e09fb31b62b1ba7d13",
    "format": "json",
    "enrichments": "details,invites,members,metrics,phases,roles",
    "projectId": 70025

}
Related AgileZen documentation

http://dev.agilezen.com/resources/projects.html#get_a_single_project

Retrieving the list of projects

The listProjects operation retrieves the list of projects.

listProjects
<agilezen.listProjects>
    <filters>{$ctx:filters}</filters>
    <page>{$ctx:page}</page>
	<pageSize>{$ctx:pageSize}</pageSize>
</agilezen.listProjects>
Properties
  • 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 listProjects operation.

Sample Request for listProjects
{
    "apiUrl": "https://agilezen.com",
    "apiKey": "7fb8d03c21d748e09fb31b62b1ba7d13",
    "format": "json",
    "enrichments": "details,invites,members,metrics,phases,roles",
    "filters": "name:Helpdesk",
    "page": 1,
    "pageSize": 100
}
Related AgileZen documentation

http://dev.agilezen.com/resources/projects.html#list_projects

Modifying a single project

The updateProject operation modifies a single project.

updateProject
<agilezen.updateProject>
    <name>{$ctx:name}</name>
    <description>{$ctx:description}</description>
    <details>{$ctx:details}</details>
    <projectId>{$ctx:projectId}</projectId>
    <ownerId>{$ctx:ownerId}</ownerId>
	<ownerUserName>{$ctx:ownerUserName}</ownerUserName>
</agilezen.updateProject>
Properties
  • name: The name of the project.
  • description: A short description of the project.
  • details: A markdown-formatted free-form description of the project with no length limit.
  • projectId: The ID of the project whose details would be updated.
  • ownerId: The ID of the owner of the project.
  • ownerUserName: Username of the owner of the project.
Sample request

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

Sample Request for updateProject
{
    "apiUrl": "https://agilezen.com",
    "apiKey": "7fb8d03c21d748e09fb31b62b1ba7d13",
    "format": "json",
    "enrichments": "details,invites,members,metrics,phases,roles",
    "name": "Helpdesk Service v2",
    "description": "This project is updated to conduct helpdesk service for enhancement requests.",
    "details": "I'm testing the updateProject method here.",
    "projectId": 70025,
    "ownerId": 93581,
    "ownerUserName": "Palamayuran"
}
Related AgileZen documentation

http://dev.agilezen.com/resources/projects.html#update_a_project

Sample configuration

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

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="agilezen_getProject" 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="projectId" expression="json-eval($.projectId)"/>
         <property name="enrichments" expression="json-eval($.enrichments)"/>
         <agilezen.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <apiKey>{$ctx:apiKey}</apiKey>
            <format>{$ctx:format}</format>
            <enrichments>{$ctx:enrichments}</enrichments>
         </agilezen.init>
         <agilezen.getProject>
            <projectId>{$ctx:projectId}</projectId>
         </agilezen.getProject>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>
  • No labels