Creating an Operation

After you optionally create a Connector, you can begin creating Operations for that Connector. Each Operation makes a particular REST API call.

Different types of Operations must be configured differently. (For specifics about how calls need to be constructed, see the REST API documentation for the system you want to connect with.) In general, however, the steps for creating an Operation are as follows.

  1. Navigate to Custom > Connector Wizard.

  2. In the Operations area, click New. The New REST Operation window displays.

  3. In the top part of the screen, specify the HTTP method and URL string for the call.

    • The HTTP method control includes options for GET, POST, PUT, PATCH, and DELETE. You can also enter a custom HTTP method.

    • The base URL is set by the parent Connector. If it is cut off, you can see the full base URL by hovering over it.

    • The Inherit / Override switch lets you choose whether to Inherit the Connector's base URL or Override it with something different. If you set the switch to Override, you can specify the entire URL for the Operation.

    • You can insert Operation Variables into the URL string using the syntax ${variableName}.

  4. In the Basic Properties screen, enter a Name and, optionally, a Description for the Operation and choose a Partition. It is a Redwood best practice to set a Default Application.

    Note: The information you specify here (including the Partition) will also be used by the Process Definition that will ultimately be created by the Operation.

  5. Click Next or Security and specify security options both for the Operation and for the Job Definition that will be created from it.

    (missing or bad snippet)

  6. Click Next or Authentication and choose an option from the Use Connection dropdown list. If you choose Yes, RunMyJobs will automatically add a Connection parameter to the generated Process Definitions, allowing you to authenticate with a REST API Connection when you submit them. If you choose No, you will need to handle authentication manually.

  7. Click Next or Variables. This screen lets you create Operation Variables that can be used as input parameters on the Process Definition that will ultimately be created from the Operation. You can use these variables in the Operation's URL, in its headers, and in the request body, using the syntax ${variableName}.

  8. Click Next or Headers. This screen lets you set the headers for the call. Note that you can use Operation Variables in the Value field.

  9. Click Next or Request Body. This screen lets you specify a Content Type for the body and then specify the contents of the request body, optionally using Operation Variables. For more information, see Operation Request Bodies.

  10. Click Next or Response. This screen lets you map all or part of the response to output parameters. For more information, see Operation Responses.

  11. Click Next or Test. This screen lets you make test calls with the configuration you have created, using input parameters created from the Variables screen. You can also specify a Connection to use for testing. For more information, see Testing Operations.

  12. When the Operation is working the way you want it to, click Save & Close. RunMyJobs creates a Process Definition based on the Operation, with the same name as the Operation. You can then begin using that Process Definition in your workflows.