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

QueryDatasetParameters

This function searches the path that you specify between the <PathName> and </PathName> tags in the request for dataset parameters.

For example, send an HTTP POST request to:

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

Include a request header:

Content-Type=application/xml

For example:

<QueryDatasetParametersRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                      xsi:type="p1:QueryDatasetParametersRequest"
                      xmlns:p1="http://ns.ca.com/2011/09/pam-ops" >
  <PathName>/TestDatasets/TestDataset</PathName>
</QueryDatasetParametersRequest>

The response contains the dataset parameters, including their JavaScript names:

<pam-ops:QueryDatasetParametersResponse 
  xmlns:pam-ops=http://ns.ca.com/2011/09/pam-ops
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:type="pam-ops:QueryDatasetParametersResponse">
  <Dataset>
    <PathName>/TestDatasets/TestDataset</PathName>
    <Parameters>
      <Param>
        <Name>Datasets["/TestDatasets/TestDataset"].Name</Name>
        <Value>John Doe</Value>
        <Label>Name</Label>
        <Type>String</Type>
      </Param>
      <Param>
        <Name>Datasets["/TestDatasets/TestDataset"].Address</Name>
        <Value>1400 Any Avenue</Value>
        <Label>Address</Label>
        <Type>String</Type>
      </Param>
      <Param>
        <Name>Datasets["/TestDatasets/TestDataset"].City</Name>
        <Value>DC</Value>
        <Label>City</Label>
        <Type>String</Type>
      </Param>
      <Param>
        <Name>Datasets["/TestDatasets/TestDataset"].Zipcode</Name>
        <Value>00000</Value>
        <Label>Zipcode</Label>
        <Type>Integer</Type>
      </Param>
      <Param>
        <Name>Datasets["/TestDatasets/TestDataset"].VMap.VarString</Name>
        <Value>updated1</Value>
        <Label>VarString</Label>
        <Type>String</Type>
      </Param>
      <Param>
        <Name>Datasets["/TestDatasets/TestDataset"].VMap.VarDate</Name>
        <Value xsi:nil="true"/>
        <Label>VarDate</Label>
        <Type>Date</Type>
      </Param>
      <Param>
    </Parameters>
  </Dataset>
</pam-ops:QueryDatasetParametersResponse>