Adding a custom name to a taskflow name using an API
Adding a custom name to a taskflow name using an API
After you publish a taskflow as a service, you can run the taskflow as an API and add a custom name to the taskflow name. When you use the API to add a custom name that contains Japanese characters, you must pass the URL encoded characters.
Navigate to the taskflow that you published as a service.
From the
Actions
menu, select
Properties Detail
.
The
Properties Detail
dialog box appears displaying the service URL and the SOAP service URL as shown in the following image:
You can also view the associated Swagger file and WSDL file.
To run the taskflow, perform one of the following steps based on the type of client that you want to use:
If you use a REST client, use the service URL and the API definition available in the Swagger file to send a request through the REST client.
If you use a SOAP client, use the SOAP service URL and the API definition available in the WSDL file to send a request through the SOAP client.
You can pass inputs using the service URL through a browser or a third-party tool. For more information, see
Passing inputs through a REST client.
You receive the taskflow run ID as the response.
In the GET request, add the TF-INSTANCE-NAME header and set the header value to the custom name that you want to use. The following image shows the custom name set to the value
OrderManagement
:
To monitor the taskflow with the run ID, use the run ID to monitor the taskflow run in the
My Jobs
page. The instance name uses the following format: