<!--
/*
 * Your installation or use of this SugarCRM file is subject to the applicable
 * terms available at
 * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.
 * If you do not agree to all of the applicable terms or do not have the
 * authority to bind the entity as an authorized representative, then do not
 * install or use this SugarCRM file.
 *
 * Copyright (C) SugarCRM Inc. All rights reserved.
 */
-->
<h2>Overview</h2>
<span class="lead">
    Returns a list with the processes for Process Management 
</span>

<h2>Summary</h2>
<span class="lead">
    This endpoint gets a list of Processes. 
</span>

<h2>Request Arguments</h2>
<table class="table table-hover">
    <thead>
        <tr>
            <th>Name</th>
            <th>Type</th>
            <th>Description</th>
            <th>Required</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>module_list</td>
            <td>string</td>
            <td>Identifier used to determine which status to filter against</td>
            <td>false</td>
        </tr>
        <tr>
            <td>order_by</td>
            <td>string</td>
            <td>How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.</td>
            <td>false</td>
        </tr>
        <tr>
            <td>q</td>
            <td>string</td>
            <td>A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.</td>
            <td>false</td>
        </tr>
        <tr>
            <td>filter</td>
            <td>string</td>
            <td>The filter expression</td>
            <td>false</td>
        </tr>
        <tr>
            <td>filter_id</td>
            <td>string</td>
            <td>Identifier for a preexisting filter. If filter is also set, the two filters are joined with an AND.</td>
            <td>false</td>
        </tr>
        <tr>
            <td>max_num</td>
            <td>integer</td>
            <td>A maximum number of records to return. Default is 20.</td>
            <td>false</td>
        </tr>
        <tr>
            <td>offset</td>
            <td>integer</td>
            <td>The number of records to skip over before records are returned. Default is 0.</td>
            <td>false</td>
        </tr>
        <tr>
            <td>fields</td>
            <td>string</td>
            <td>Comma delimited list of fields to return</td>
            <td>false</td>
        </tr>
        <tr>
            <td>deleted</td>
            <td>boolean</td>
            <td>Boolean to show deleted records in the result set.</td>
            <td>false</td>
        </tr>
    </tbody>
</table>

<h2>Response Arguments</h2>
<table class="table table-hover">
    <thead>
        <tr>
            <th>Name</th>
            <th>Type</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>next_offset</td>
            <td>Integer</td>
            <td>Next offset</td>
        </tr>
        <tr>
            <td>records</td>
            <td>&lt;field&gt;/&lt;value&gt;</td>
            <td>List of process attributes</td>
        </tr>
    </tbody>
</table>

<h3>Response</h3>
<pre class="pre-scrollable">
{
    {
        "next_offset":-1,
        "records":
        [
            {
                "id":"3922976c-284f-11e6-9f40-6c4008960436",
                "name":"ABC2",
                "date_entered":"2016-06-01T16:18:59-07:00",
                "date_modified":"2016-06-01T16:18:59-07:00",
                "modified_user_id":"1",
                "created_by":"1",
                "deleted":"0",
                "cas_id":"2",
                "cas_parent":"0",
                "cas_status":"IN PROGRESS",
		"pro_id":"6e172e2c-2842-11e6-a4bb-6c4008960436",
		"cas_title":"ABC2",
		"cas_custom_status":"",
		"cas_init_user":"1",
		"cas_create_date":"2016-06-01T16:18:59-07:00",
		"cas_update_date":"2016-06-01 23:18:59",
		"cas_finish_date":null,
		"cas_assigned_status":"UNASSIGNED",
		"cas_module":"Accounts",
		"team_id":"1",
		"team_set_id":"1",
		"assigned_user_id":"1",
		"assigned_user_name":"Administrator",
		"prj_id":"6e025038-2842-11e6-b4f7-6c4008960436",
		"prj_created_by":"1",
		"prj_module":"Accounts",
		"cas_sugar_module":"Accounts",
		"cas_sugar_object_id":"38beb03a-284f-11e6-b059-6c4008960436",
		"pro_title":"PD1",
		"prj_deleted":"0",
		"prj_user_id_full_name":"Administrator",
		"cas_user_id_full_name":"Sarah Smith"
            },
    } 
}
</pre>
