tencent cloud

Feedback

Manually Triggering Workflow

Last updated: 2022-05-17 15:58:23

    Overview

    This API (Trigger Workflow) is used to manually trigger a workflow.

    Request

    Sample request

    POST /triggerworkflow?workflowId=xxx&object=xxx HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    Content-Length: <length>
    Content-Type: application/xml
    
    Note:

    Authorization: Auth String (for more information, see Request Signature).

    Request parameters

    Field Description Type Required
    workflowId ID of the workflow to trigger String Yes
    object Name of the object that requires workflow processing String Yes
    name Name of the existing triggered task, which can contain up to 128 letters, digits, hyphens, and underscores and is empty by default String No

    Request headers

    This API only uses common request headers. For more information, see Common Request Headers.

    Request body

    The request body of this request is empty.

    Response

    Response headers

    This API only returns common response headers. For more information, see Common Response Headers.

    Response body

    The response body returns application/xml data. The following contains all the nodes:

    <Response>
      <RequestId>NjA0MWExNGVfOTBmYTUwNjRfMzc0M****</RequestId>
      <InstanceId>i6fc78ca77d6011eba0ac5254008618d9=</InstanceId>
    <Response>
    

    The nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type
    Response None Response container Container

    Response has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    RequestId Response Unique ID of the request String
    InstanceId Response Instance ID String

    Error codes

    There are no special error messages for this request. For common error messages, see Error Codes.

    Use Cases

    Request

    POST /triggerworkflow/?workflowId=xxx&object=xxx HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
    Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 0
    Content-Type: application/xml
    

    Response

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 100
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    
    <Response>
           <RequestId>NjA0MWExNGVfOTBmYTUwNjRfMzc0M****</RequestId>
           <InstanceId>i6fc78ca77d6011eba0ac5254008618d9=</InstanceId>
    <Response>
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support