Sends an HTTP callback to resume the corresponding workflow execution.
HTTP request
NONE https://workflowexecutions.googleapis.com/v1/{workflow=projects/*/locations/*/workflows/*}/executions/{executionId}/callbacks/{callbackId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
workflow |
Required. Resource path for the workflow the callback belongs to. Authorization requires the following IAM permission on the specified resource
|
executionId |
Required. The ID of the execution. |
callbackId |
Required. The ID of the callback. |
Request body
The request body contains an instance of HttpBody
.
Response body
If successful, the response body is empty.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
HttpBody
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
This message can be used both in streaming and non-streaming API methods in the request as well as the response.
It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.
Example:
message GetResourceRequest {
// A unique request id.
string request_id = 1;
// The raw HTTP body is bound to this field.
google.api.HttpBody http_body = 2;
}
service ResourceService {
rpc GetResource(GetResourceRequest)
returns (google.api.HttpBody);
rpc UpdateResource(google.api.HttpBody)
returns (google.protobuf.Empty);
}
Example with streaming methods:
service CaldavService {
rpc GetCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
rpc UpdateCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
}
Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
JSON representation |
---|
{ "contentType": string, "data": string, "extensions": [ { "@type": string, field1: ..., ... } ] } |
Fields | |
---|---|
contentType |
The HTTP Content-Type header value specifying the content type of the body. |
data |
The HTTP request/response body as raw binary. A base64-encoded string. |
extensions[] |
Application specific response metadata. Must be set in the first response for streaming APIs. An object containing fields of an arbitrary type. An additional field |