RESTful API Reference › RESTful Web Services and CA Process Automation › Catalyst Process Automation Services › Features › Custom Operations › Start Request Operations › Examples › QueryStartRequests

QueryStartRequests

The QueryStartRequests operation lets you query a start request form instance for the start request Status and the associated Process instance ID.

Follow these steps:

1. Create a process.
2. Drag the Execute operator to the Designer.
3. Double-click the Execute operator to open the Properties palette.
4. Enter the required parameters.

   Catalyst Security

   Username: (Catalyst user name)

   Password: (Catalyst password)

   Claims:

   ClaimName: Username

   ClaimValue: pamadmin

   PasswordClaims:

   ClaimName: Password

   ClaimValue: pamadmin

   Execute

   CatalystBrokerURL: https://hostname:7443/ucf/BrokerService

   MdrProduct: "CA:00074 (CA Process Automation)"

   MdrProdInstance: "CA:00074:01"

   Operation Category: "CA Process Automation"

   Operation: QueryStartRequests

5. Identify the start request form instance that is in the Queued state.
   1. In the Execute Properties, click Parameters.
   2. On the QueryStartRequestsRequest tab, enter the following values:

      Instance: "SRF_Queue_x" (where x is the instance ID of the start request form that you want to query). For example, "SRF_Queue_5829".

      IsArchived: "false"

6. Run the process.
7. Review the output.

   In the following illustration, the output parameters display the start request form in the queued state.

   

   In the following illustration, the output parameters show a list of all the archived start request form instances. To get archived results, do not include the instance name in the input parameters, but provide true or false for the IsArchived parameter.