MAPI Manual

NAME

LIST_AGILES

FUNCTION

List agiles

SYNOPSIS

keyword_set, ctime_from, ctime_to, order_by, status_list, maptemplate_id_list, return_range

DESCRIPTION

This function allows users to list agiles.

Required Parameters

* action: LIST_AGILES.

Optional Parameters

* keyword_set: searches the agiles for titles and descriptions matching the given keyword set.
* ctime_from: the beginning of time frame. It searches the agiles for timestamp within the given time frame. The format of timestamp is "YYYY-MM-DD HH:MM:SS". Special characters must be URL encoded.
* ctime_to: the end of time frame. The format of timestamp is "YYYY-MM-DD HH:MM:SS". Special characters must be URL encoded.
* order_by: specifies the list order. The results can be ordered by any column definition of an agile. Default is ordered by the "last_update_dt" in descending order.
* status_list: searches for the agiles with status included in this status list.
* maptemplate_id_list: searches for the agiles with template IDs given in this list.
* return_range: specifies the return range of the list results. It accepts two formats - either a number or two numbers separated by a comma. For example, if value is "5", the function will return the first five results to users; if value is "5,10", the function will return the results that were ordered within this range. 

RETURN DATA

The response contains the following attributes:
* mcp_agile_id: agile ID.
* agile_title: agile title.
* agile_description: description of the agile.
* mcp_taskfunc_id: the transaction ID.
* mcp_dialogmap_id: dialogmap ID.
* mcp_dialogmap_node_id: the node ID.
* begin_dt: the start time of the agile activity.
* end_dt: the finish time of the agile activity.
* tz_abbr_forschedule: the time zone abbreviation for scheduled agile activity.
* mcp_schedule_id: the schedule ID.
* mcp_acl_id:
* completedcondition_type: conditions on completion.
* mcp_integration_partner_id: the partner ID for integration.
* mcp_integration_agile_id:
* status: the status of the agile activity.
* status_dt: timestamp of the status.
* last_update_dt: timestamp when the agile was last updated.
* mcp_destinfo: the recipient of the agile message.
* ui_icon: icon for this agile.

ROLE PERMITTED

Manager

EXAMPLES

The following example shows a successful HTTP GET request and response.

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=LIST_AGILES&login_name=user@example.com&login_passwd=1111  

Response:
<result tftype='1' infotype='0'>
    <resultset name='mcp_agile' search_found_rows='44'>
        <row>
            <field name='mcp_agile_id'>956</field>
            <field name='agile_title'>Agile sample updated</field>
            <field name='agile_description'>Agile sample updated</field>
            <field name='mcp_taskfunc_id'>7411</field>
            <field name='mcp_dialogmap_id'>0</field>
            <field name='mcp_dialogmap_node_id'>0</field>
            <field name='begin_dt'>2014-08-26 12:10:36</field>
            <field name='end_dt'>2014-08-31 12:10:36</field>
            <field name='tz_abbr_forschedule'>TZ89</field>
            <field name='mcp_schedule_id'>1</field>
            <field name='mcp_acl_id'>0</field>
            <field name='completedcondition_type'>MCPTYPE_NOTASK</field>
            <field name='mcp_integration_partner_id'>0</field>
            <field name='mcp_integration_agile_id'></field>
            <field name='status'>complete</field>
            <field name='status_dt'>2014-08-26 12:10:37</field>
            <field name='last_update_dt'>2014-08-26 12:10:36</field>
            <field name='mcp_destinfo'>demo group three</field>
            <field name='ui_icon'>sms_128x128.png</field>
        </row>
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014