MAPI Manual

NAME

SAVE_AGILE_BYSTENCIL

FUNCTION

Save Agile by stencil

SYNOPSIS

agile_id, agile_title, keep_draft, funtemplate_id, funtemplate_stencil_id, xlabel_id_list, xlabel1...xlabelN

DESCRIPTION

This function allows users to update an existing agile or create a new one if not exists. If the ID of an existing agile is provided, the agile will be updated; otherwise, a new agile will be created.

Required Parameters

* action: SAVE_AGILE_BYSTENCIL.
* agile_title: agile title.
* keep_draft: specifies whether the draft will be saved or not. Value is "ON" or "OFF". "ON" means that the draft will be saved.
* funtemplate_id: the template ID.
* funtemplate_stencil_id: the stencil ID.
* xlabel1...xlabelN: specifies the values of the fields within the stencil. The fields are represented in the form of numbered xlabels.

* xlabel_id_list: contains the IDs of all the xlabels for this stencil. For more information about the xlabels for current stencils of function templates, see ADD_AGILE_BYSTENCIL.

Optional Parameters

* agile_id: agile ID. ID of the agile that needs to be updated.

RETURN DATA

On successful update of the agile, the response contains the following attribute:

* msg: Success or error message.


On successful creation of a new agile, the response contains the following attribute:

mcp_agile_id: ID of the newly created agile.

ROLE PERMITTED

Manager

EXAMPLES

The following example shows a successful HTTP GET request and response. It creates a new agile since agile ID is not given in the request.

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=SAVE_AGILE_BYSTENCIL&agile_title=new%20agile%20message&keep_draft=ON&funtemplate_id=100&funtemplate_stencil_id=2&xlabel10=12&xlabel11=164&xlabel12=2&xlabel13=Hello%20World&xlabel_id_list=10_1%2C11_25%2C12_22%2C13_10001&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <field name='mcp_agile_id'>1098</field>
</result>




The following example finds the agile ID and updates this agile.

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=SAVE_AGILE_BYSTENCIL&agile_id=1098&agile_title=Updated%20new%20agile%20message&keep_draft=ON&funtemplate_id=100&funtemplate_stencil_id=2&xlabel10=12&xlabel11=164&xlabel12=2&xlabel13=Hello%20world%20updated&xlabel_id_list=10_1%2C11_25%2C12_22%2C13_10001&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <field name='msg'>SUCCESS</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

ADD_AGILE_BYSTENCIL, UPDATE_AGILE_BYSTENCIL

Mweb v2.0 YVNTECH 2014