Method: legacyPlaybooks.LegacyPlaybookApplyApprovalLink

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
  • JSON representation
• Authorization scopes
• ApprovalLinkStatusValue
• ApprovalLinkActionTypeValue
• Try it!

Full name: projects.locations.instances.legacyPlaybooks.LegacyPlaybookApplyApprovalLink

legacyPlaybooks.LegacyPlaybookApplyApprovalLink applies an approval link to a workflow.

HTTP request

Choose a location:

africa-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-central2 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu

POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacyPlaybooks:legacyApplyApprovalLink

Path parameters

Parameters
instance	string Required. The instance to apply the approval link for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation
{ "encryptedData": string, "hashedEncryptedData": string, "isApproved": boolean }

Fields
encryptedData	string Required. The encrypted data.
hashedEncryptedData	string Required. The hashed encrypted data.
isApproved	boolean Optional. Indicates if the link is approved.

Response body

LegacyPlaybookApprovalLinkResult represents the result of an approval link.

If successful, the response body contains data with the following structure:

JSON representation
{ "status": enum (ApprovalLinkStatusValue), "caseId": string, "actionName": string, "approvalLinkActionType": enum (ApprovalLinkActionTypeValue) }

Fields
status	enum (ApprovalLinkStatusValue) Required. The status of the approval link.
caseId	string (int64 format) Required. The case id.
actionName	string Required. The action name.
approvalLinkActionType	enum (ApprovalLinkActionTypeValue) Required. The type of the approval link action.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ApprovalLinkStatusValue

ApprovalLinkStatusValue represents the status of an approval link.

Enums
APPROVAL_LINK_STATUS_VALUE_UNSPECIFIED	The status is unspecified.
SUCCESS	The status is success.
STEP_NOT_FOUND	Step not found status.
STEP_ALREADY_EXECUTED	Step already executed status.
STEP_TIME_TO_RESPONSE_EXPIRED	Step time to response expired status.
STEP_NOT_PENDING	Step not pending status.
CLICK_REQUIRED	Click required status.

ApprovalLinkActionTypeValue

ApprovalLinkActionTypeValue represents the type of an approval link action.

Enums
APPROVAL_LINK_ACTION_TYPE_VALUE_UNSPECIFIED	The action type is unspecified.
APPROVE	The action type is approve.
DECLINE	The action type is decline.
MULTI_CHOICE_ANSWER	The action type is multi choice answer.