Creating an Operation for an Existing Service

Add a new operation to an existing service in the Service Workbench.

Implementation:

  1. Click to access the Service Workbench tab.
  2. Select the provider and service to which you want to add the operation.
  3. Open the Service Options menu and select Service Operations. This opens the Manage Operations interface.
  4. Click Add to create a new operation.
  5. Select the operation and switch to the Details tab.
  6. Enter a title for the operation in the Name field.
  7. (Optional) The Reference field will automatically fill to match the name you entered. However, you can edit this if required. The reference is used when calling the service using the WorkbenchRequest function.
  8. Enter a Description, explaining the purpose of the operation.
  9. Enter the service's website address in the Service Web Page URL field.
  10. (Optional) Click the Test URL button to open the website in your default browser to ensure it is correct.
  11. Switch to the Parameters tab.
  12. Add all the Parameters required by the operation, along with their values. The parameters determines what the operation does and how its functionality is executed, so these will differ depending on the API service you are using.

Many RESTful API web services will provide reference documentation for which parameters and values are required. For example, you can find comprehensive information about Microsoft's API services in their reference catalog.

  1. When you've added all necessary parameters, click Save.