Message Start Event (HTTP)

Capture

Notes

• Communication from the external network is not permitted by default on the Workflow platform
  • To allow communication from an external network, change the settings in [IP Address Filtering] < [System Settings] (System Administrator Authority Required)
    • M312: Filtering on Source IP Address
  • It is possible to set an IP address filter for each trigger URL
• You can check and copy the launching URL to clipboard in the property screen
• The parameter and IP filtering details can be checked in the other page after clicking the [URL, Reception Parameter] button in the property screen
• The value of API key (key) can be set arbitrarily with halfwidth alphanumeric characters, at most 100 in length
  • Even though it is possible to leave the API key blank, please set the API key to tighten the security
• Numeric-type Data Items in which an arithmetic expression has been set cannot be set to Editable
• Please make requests with POST (application/x-www-form-urlencoded or multipart/form-data)
  • R2210: Naming Convention for Data Receiving Parameter
• To send a file, use one of the following methods:
  • Use the pre-upload API to upload the file before starting the process
    • API endpoint: /System/Event/MessageStart/{app ID}/{node number}/File/upload?key={API key}
    • HTTP method and Content-Type: POST (multipart/form-data)
    • Pass the file ID obtained in the response as the parameter (q_XXX) value of the File-type data item when requesting to start the process
      • If there are multiple attachments (file IDs), specify multiple parameters (same as for Select-type)
    • The maximum size for a single file is 100MB, but you can send files totalling more than 100MB
  • No pre-uploading is performed, and the file is sent when the process is started
    • HTTP method and Content-Type: POST (multipart/form-data)
    • The total size of the request must not exceed 100MB
• If the incoming request has a “Questetra-Debug: true” header, it will start as a debug process
  • If the caller is a debug process, or the header has been explicitly added
  • Human Task handling in the debugging Process is assigned to the final editor of the App
• If successfully processed, the ID (number) of the newly started process is returned
  • The HTTP response code is 200 and the Content-Type is text/plain
• If processing fails, an HTTP response code other than 200 is returned
  • An HTTP response code of 400 and an error message in XML format (text/xml) are returned in the following cases
    • The received data does not include content for the required settings in the process data item that will store the data, and does not meet the minimum/maximum number of characters and input validation conditions of the item
    • Invalid values for the parameters such as App ID
    • The number of running processes has already reached the limit of the workflow platform
      • R2170: Limitation on the Number of Running Processes
    • R2212: XML Format of Error Responses for Receiving HTTP Requests
  • HTTP response codes in the 400s are returned, but the response body is not specified in the following cases
    • The received HTTP request has exceeded the data size limit that can be received via HTTP communication
      • R2211: HTTP Communication Restrictions
    • The HTTP request format (method/Content-Type) is not the required format
• When a Process is started by calling this event from a [Throwing Message Intermediate Event (HTTP)], etc. within the same platform, a parent-child relationship is established with the started Process as a child and the calling Process as a parent
  • The child Process has the ID of the parent Process as Process attribute information
• [Service Task (Start Child Process)] is an item for sending an HTTP request to this Start Event to start a child Process
  • When a [Message Start Event (HTTP)] is set, the corresponding [Service Task (Start Child Process)] will appear in the modeler palette one by one
    • For more information about [Service Task (Start Child Process)], please refer to the following page
      • Service Task (Start Child Process)

See also

• Linking and Operating Multiple Workflow Apps
  • Splitting Apps Edition / Sub-Process Edition
• Starting a Process from Outside of Questetra BPM Suite
  • Preparatory Chapter / curl Chapter / Python Chapter / Error-handling Chapter
• M221: Auto Start Triggered by HTTP Request
• M411: Auto-starting a “Billing Process” Triggered by a “Shipping Process”
• BPMN icons: Service Task (Start Child Process)
• BPMN icons: Throwing Message Intermediate Event (HTTP)