Hi, there!
Cloud-based Workflow Questetra has various APIs and its capability of cooperating with various services is one of the characteristics.
Then, what kind of API is provided? Since it has evolved little by little and got diverse, so I tried organizing it in my own way. I suppose you can understand its outline by taking a look over the headlines of each chapter, first.
* Although it mainly covers REST API, since we may also use email in system linkage, so I include it and summarized below.
* Since it is the content at the time I am writing this article (Questetra Ver. 11.6.0 as of May 21, 2018), newer information than that is not included. Please note.
https://xxxxx.questetra.net/Swagger/index
The link to the manual of online demo environment is as follows. There, you can see the manual immediately even if you do not have a Questetra environment.
System Settings API
Workflow API
2. API Authentication
3. Retrieving processing result of Questetra
4. Task Operating and Starting of flow on Questetra
5. Settings of User, Organization, Role, and Privileges
6. Setting of Business Flow definition (Questetra App definition)
7. Settings of Options Master
8. Closing
1. Communication with external (other services) in business flow
This is the most frequently used.
Every usage listed here will be prepared by embedding the parts in the Workflow diagram.
Specify API key for reception authentication.
Starting a flow by receiving data from external (HTTP, email)
See the following for the details.
M221: Auto Starting Triggered by HTTP Request
M218: Auto Starting Triggered by Incoming Email
* It can also receive Webhook containing JSON.
Starting Workflow with Webhook from Backlog (Currently preparing for migration)
* Although it is not using API, you can also Start a Workflow from a Web form.
M220: Auto Starting Triggered by Published Web Form Entry
Sending data to external in the middle of a flow (HTTP, email)
See the following for the details.
M225: Auto Sending of HTTP Request with Business data Inserted
M224: Auto Sending of Email with Business data Inserted
* Concerning HTTP transmission, Basic Authentication, OAuth 2, and HTTP header specification (restricted in header name) are available.
* HTTP transmission by Script Task is also available. (For details, refer to HttpRequestWrapper in Java class available for Script Task) Many Add-ons that work with other services use that mechanism. The following are examples.
M230: Auto Executing Complicated Data Processing (ECMAScript)
Blog post: Connecting ChatWork with Cloud Workflow
Data reception from external in the middle of a flow (HTTP)
See the following for the details.
M226: Standing by HTTP Request
* Standing by until data is received, and the flow will continue after receiving.
M318: Controlling Accesses from External to [Message Catch Event API]
* In case of email reception, it is possible to analyze the email body in the Script Task and capture it as data. See the following for the details.
M230: Auto Executing Complicated Data Processing (ECMAScript)
* In order to receive Workflow Start by e-mail (Message Start Event (Email)), you need to grant permission beforehand. See the following for the details.
M318: Controlling Accesses from External to [Message Catch Event API]
* We have prepared a lot of Add-on parts which have been made using these mechanisms.
List of Service Task Add-ons
M415: Adding an Auto-Step to be Used for Business Process Definition
Also, there is a dedicated part to output to Google Drive.
M229: Auto Backup to Google Drive
2. API Authentication
Authentication is required for the following use of the API.
There are two types, Basic Authentication and OAuth 2, and to accept Basic Authentication, permission is required beforehand. See the following for the details.
M317: Controlling OAuth2 Authorization Access and Basic Authentication Access from External
3. Retrieving processing result of Questetra
This is used when analyzing, etc. processing results in Questetra at external.
Acquiring processed data of Workflow (Process), downloading attached files
See the following for the details.
- list, view, and file in „ProcessInstance“ in „Workflow API“ in „API Manual“
- list in „Workitem“ in „Workflow API“ in „API Manual“
* ProcessInstance = Process, Workitem = Task
The latter is for acquiring information specific to tasks, but in my personal experience, it was sufficient with the former in most of the cases.
* There are three formats for list, such as list (JSON), listCsv (csv), listCsvUtf16 (UTF16 csv).
XML: Criteria for Process Instance Search
XML: Criteria for Workitem Search
4. Task Operating and Starting of flow on Questetra
This is used when starting Workflow (Process) or executing Task Operation of Questetra, from external. It is also used when developing smartphone applications wrapping these processings.
Starting Workflow (Process)
See the following for the details.
- start in „ProcessInstance“ in „Workflow API“ in „API Manual“
Task Operation, retrieving information for displaying Task Operating screen
See the following for the details.
- „WorkitemForm“ in „Workflow API“ in „API Manual“
* It is basically to acquire information for Task Operation with viewXml and Operate the Task with save based on it, but it can be directly Operate with saveas long as the target Task is identified.
Retrieving a list of Tasks in My Tasks/Offered
See the following for the details.
- listAllocated, listOffered in „Workitem“ in „Workflow API“ in „API Manual“
Accepting Tasks in Offered collectively
See the following for the details.
- batchAccept in „Workitem“ in „Workflow API“ in „API Manual“
Forced termination/Deletion of Workflow (Process)
See the following for the details.
- stop, delete in „ProcessInstance“ in „Workflow API“ in „API Manual“
Forced allocation of Tasks
See the following for the details.
- reallocate, delete in „Workitem“ in „Workflow API“ in „API Manual“
Adding/deleting „stars“ to Tasks
See the following for the details.
- star, delete in „Workitem“ in „Workflow API“ in „API Manual“
5. Settings of User, Organization, Role, and Privileges
This is used for, such as you want to synchronize user information with an authentication server.
Adding/retrieving/updating/deleting of user account
See the following for the details.
- „Quser“ in „System Settings API“ in „API Manual“
Adding/retrieving/updating/deleting of Organization
See the following for the details.
- „Qgroup“ in „System Settings API“ in „API Manual“
Adding/retrieving/deleting affiliation of users to Organizations
See the following for the details.
- „Membership“ in „System Settings API“ in „API Manual“
Adding/retrieving/updating/deleting of Role
See the following for the details.
- „Qrole“ in „System Settings API“ in „API Manual“
Adding/retrieving/deleting affiliation of users to Role
See the following for the details.
- „RoleMembership“ in „System Settings API“ in „API Manual“
Granting/deleting system privileges
See the following for the details.
- „SystemAuthority“ in „System Settings API“ in „API Manual“
Granting/deleting privileges for Workflow definition (Questetra App)
See the following for the details.
- „ProcessAuthority“ in „Workflow API“ in „API Manual“
6. Setting of Workflow definition (Questetra App definition)
This is used for, such as you want to enable new Apps automatically on the due date.
Retrieving a list of Workflow definition (Questetra App)
See the following for the details.
- „ProcessModel“ in „Workflow API“ in „API Manual“
Releasing (activating) Workflow definition (Questetra App)
See the following for the details.
- „ProcessModel“ in „Workflow API“ in „API Manual“
Retrieving a list of startable Workflow definition (Questetra App)
See the following for the details.
- „ProcessModel“ in „Workflow API“ in „API Manual“
7. Settings of Options Master
In case you set the Options Master to be acquired from external via HTTP, it will be cached. Therefore, you need to consider cache clearing for updating the Master.
Retrieving/deleting a list of cached Options Master
See the following for the details.
- „ItemCache“ in „Workflow API“ in „API Manual“
Concerning „Options Master“, see the following for the details.
M319: Register an Options-XML file to which the Process Model Definitions Refer to
8. Closing
I suppose you have understood that we have quite a lot of APIs.
If you have any questions, please feel free to Contact us.
Apply for Starter Plan (Free) Here
By applying for your Free account of your own Questetra, you will be able to use all the Questetra features including what I mentioned above.
Please click HERE to go to the Web form.
