RESTful API Reference › RESTful Web Services and CA Process Automation › Catalyst REST › Start Request REST Examples › QueryStartRequestForms

QueryStartRequestForms

You can use an optional filter with a library path to query start request forms.

For example, send an HTTP POST request to:

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

Include a request header:

Content-Type=application/xml

For example:

<QueryStartRequestFormsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                               xsi:type="p1:QueryStartRequestFormsRequest"
                               xmlns:p1="http://ns.ca.com/2011/09/pam-ops" >
  <Filter>
    <LookUpPath>/TestSRF</LookUpPath>
    <IsRecursive>true</IsRecursive>
        <Keywords>
      <Keyword>
        <Name>TagValue</Name>
      </Keyword>
    </Keywords>
  </Filter>
</QueryStartRequestFormsRequest>

As the following example shows, the response from QueryStartRequestForms includes the start request form parameter names and types (shown in bold in the example). The SubmitStartRequestForm operation uses the parameter names and types.

<?xml version="1.0" encoding="utf-8"?>
<pam-ops:QueryStartRequestFormsResponse xmlns:pam-ops="http://ns.ca.com/2011/09/pam-ops"
                                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                                        xsi:type="pam-ops:QueryStartRequestFormsResponse">
  <StartRequestForms>
    <StartRequestForm>
      <Name>SRF</Name>
      <Path>/TestSRF/</Path>
      <Description>my test srf description</Description>
      <Pages>
        <HasComplexType>false</HasComplexType>
        <Page>
          <Name>TestPage</Name>
          <Param>
            <Name>Var_0</Name>
            <Label>Text Field</Label>
            <Description/>
            <IsReadOnly>false</IsReadOnly>
            <Type>String</Type>
          </Param>
          <Param>
            <Name>Var_1</Name>
            <Label>Check Box</Label>
            <Description/>
            <IsReadOnly>false</IsReadOnly>
            <Type>Boolean</Type>
          </Param>
          <Param>
            <Name>Var_2</Name>
            <Label>Select</Label>
            <Description/>
            <IsReadOnly>false</IsReadOnly>
            <Type>String</Type>
          </Param>
        </Page>
        <Page>
          <Name>System</Name>
        </Page>
      </Pages>
    </StartRequestForm>
  </StartRequestForms>
</pam-ops:QueryStartRequestFormsResponse>