Page Comparison

...

Overview

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

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

Operation details

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

Anchor
createComment createComment

Creating a comment 

The createComment operation creates a comment in the specified story.

<agilezen.createComment>
    <text>{$ctx:text}</text>
    <storyId>{$ctx:storyId}</storyId>
	<projectId>{$ctx:projectId}</projectId>
</agilezen.createComment>

Properties

• text: The text of the comment.
• storyId: The ID of the story to which the comment belongs.
• projectId: The ID of the project to which the story belongs.

  

Anchor
request request

Sample request

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

...

Related AgileZen documentation

http://dev.agilezen.com/resources/comments.html#create_a_new_comment

Anchor
getComment getComment

Retrieving a single comment from the specified story

The getComment operation retrieves a single comment from the specified story.

<agilezen.getComment>
   <commentId>{$ctx:commentId}</commentId>
    <storyId>{$ctx:storyId}</storyId>
	<projectId>{$ctx:projectId}</projectId>
</agilezen.getComment>

Properties

• commentId: The ID of the comment whose details need to be updated.
• storyId: The ID of the story to which the comment belongs.
• projectId: The ID of the project to which the story belongs.

  

Anchor
request request

Sample request

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

...

Related AgileZen documentation

http://dev.agilezen.com/resources/comments.html#get_a_comment

Anchor
listComments listComments

Retrieving the list of comments from the specified story

The listComments operation retrieves the list of comments from the specified story.

<agilezen.listComments>
    <storyId>{$ctx:storyId}</storyId>
    <projectId>{$ctx:projectId}</projectId>
    <filters>{$ctx:filters}</filters>
    <page>{$ctx:page}</page>
	<pageSize>{$ctx:pageSize}</pageSize>
</agilezen.listComments>

Properties

• storyId: The ID of the story to which the comments 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.

  

Anchor
request request

Sample request

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

...

Related AgileZen documentation

http://dev.agilezen.com/resources/comments.html#list_comments_within_a_story

Anchor
updateComment updateComment

Modifying a single comment in the specified story

The updateComment operation modifies a single comment in the specified story.

<agilezen.updateComment>
    <commentId>{$ctx:commentId}</commentId>
    <storyId>{$ctx:storyId}</storyId>
    <projectId>{$ctx:projectId}</projectId>
	<text>{$ctx:text}</text>
</agilezen.updateComment>

Properties

• commentId: The ID of the comment to update.

• storyId: The ID of the story to which the comment belongs.
• projectId: The ID of the project to which the story belongs.
• text: The text of the comment.

  

Anchor
request request

Sample request

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

...

Related AgileZen documentation

http://dev.agilezen.com/resources/comments.html#update_a_comment

Anchor
sampleconfiguration sampleconfiguration

Sample configuration

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

<?xml version="1.0" encoding="UTF-8"?>
<proxy name="agilezen_createComment" 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="text" expression="json-eval($.text)"/>
         <property name="storyId" expression="json-eval($.storyId)"/>
         <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.createComment>
            <text>{$ctx:text}</text>
            <storyId>{$ctx:storyId}</storyId>
            <projectId>{$ctx:projectId}</projectId>
         </agilezen.createComment>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>