REST API - listPageFlows

The table summarizes the REST API - listPageFlows.

Request

Format 
GET <baseurl>/pageflow/list
Query parameters
  • start=long (optional, default = 0): Position in the list from which to start this page.
  • total=long (optional, default = 0): Number of items (in the list) to include in this page.
  • gettotal=boolean (optional, default = true): Whether to build a count of the total number of items in the list.
  • includeparam=boolean (optional, default = true): Whether the response should include pageflows that have formal parameters.

Response

JSON Returns a JSON representation of the contents of a listPageFlowsResponse element.
XML Returns the contents of a listPageFlowsResponse element (from the PageFlowService schema).

Example

Request 
GET <baseurl>/pageflow/list
Response 
{
    "xml-fragment": {
        "startPosition": 0,
        "endPosition": 1,
        "totalItems": 1,
        "pageFlowTemplate": {
            "@hasFormalParameters": "true",
            "@moduleName": "/RestSample1/ProcessPackages/RestSample1.xpdl",
            "@version": "1.0.0.201301031722",
            "@processName": "GetInfoFromCustomer"
        }
    }
}