RESTful API Reference › RESTful Web Services and CA Process Automation › Catalyst REST › Dataset REST Examples › QueryProcessDataset

QueryProcessDataset

This function searches for a process dataset. You specify the process instance name that includes the dataset that you want to query in the <InstanceName> tag in the REST request.

For example, send an HTTP POST request to:

http://<hostname>:7000/node/rest/CA:00074_CA:00074:01/_ops/QueryProcessDataset

Include a request header:

Content-Type=application/xml

For example, a REST request could be:

<QueryProcessDatasetRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                      xsi:type="p1:QueryProcessDatasetRequest"
                      xmlns:p1="http://ns.ca.com/2011/09/pam-ops" >
  <InstanceName>Process_388</InstanceName>
</QueryProcessDatasetRequest>

The response returns the process dataset under the <ProcessDataset> tag. The REST response returns any parameters that are included in the dataset. For example:

    <?xml version="1.0" encoding="UTF-8"?>
    <pam-ops:QueryProcessDatasetResponse xmlns:pam-ops="http://ns.ca.com/2011/09/pam-ops" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="pam-ops:QueryProcessDatasetResponse">
    <ProcessDataset>
    <InstanceName>Process_388</InstanceName>
    <Parameters>
    <Param>
    <Name>ParentProcessROID</Name>
    <Value/>
    <Label>ParentProcessROID</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>RootProcessROID</Name>
    <Value/>
    <Label>RootProcessROID</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>Progress</Name>
    <Value>100.0</Value>
    <Label>Progress</Label>
    <Type>Double</Type>
    </Param>
    <Param>
    <Name>TouchpointName</Name>
    <Value>Orchestrator</Value>
    <Label>TouchpointName</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>ServerName</Name>
    <Value>SINRA22.ca.com</Value>
    <Label>ServerName</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>ServerId</Name>
    <Value>1ed56246-7880-4c10-8a5f-5a9975c17d9b</Value>
    <Label>ServerId</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>DisplayName</Name>
    <Value>Process</Value>
    <Label>DisplayName</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>InstanceUUID</Name>
    <Value>024d68c3-1248-484b-aca1-ef8584492eac</Value>
    <Label>InstanceUUID</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>rootUUID</Name>
    <Value>024d68c3-1248-484b-aca1-ef8584492eac</Value>
    <Label>rootUUID</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>CallerUser</Name>
    <Value>pamadmin</Value>
    <Label>CallerUser</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>effectiveUser</Name>
    <Value>pamadmin</Value>
    <Label>effectiveUser</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>RuntimeROID</Name>
    <Value>388</Value>
    <Label>RuntimeROID</Label>
    <Type>Long</Type>
    </Param>
    <Param>
    <Name>InstanceName</Name>
    <Value>Process_388</Value>
    <Label>InstanceName</Label>
    <Type>String</Type>
    </Param>
    <Param>
    <Name>ScheduledStartTime</Name>
    <Value>01/14/2013</Value>
    <Label>ScheduledStartTime</Label>
    <Type>Date</Type>
    </Param>
    <Param>
    <Name>StartDate</Name>
    <Value>01/14/2013</Value>
    <Label>StartDate</Label>
    <Type>Date</Type>
    </Param>
    <Param>
    <Name>StartTime</Name>
    <Value>01/14/2013</Value>
    <Label>StartTime</Label>
    <Type>Date</Type>
    </Param>
    <Param>
    <Name>EndTime</Name>
    <Value>01/14/2013</Value>
    <Label>EndTime</Label>
    <Type>Date</Type>
    </Param>
    <Param>
    <Name>EndDate</Name>
    <Value>01/14/2013</Value>
    <Label>EndDate</Label>
    <Type>Date</Type>
    </Param>
    <Param>
    <Name>Result</Name>
    <Value>1</Value>
    <Label>Result</Label>
    <Type>String</Type>
    </Param>
    </Parameters>
    </ProcessDataset>
    </pam-ops:QueryProcessDatasetResponse>