cancel_build_workflow

ArtificialIntelligenceApi.cancel_build_workflow(policy_id, build_workflow_id, role_id, action=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Cancel or sync an Automated Reasoning build workflow

Omitting action cancels a non-terminal workflow. action=sync applies a completed workflow POLICY_DEFINITION into the policy and marks Approved true. Requires owner access.

Parameters:

  • policy_id (str) – (required)

  • build_workflow_id (str) – (required)

  • role_id (str) – (required)

  • action (str) – Set to sync to apply the completed workflow result to the policy. Omit to cancel the workflow.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

CancelOrSyncBuildWorkflowResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /ai/reasoning-policies/{policy_id}/build-workflows/{build_workflow_id}

Success (HTTP 200)

Successfully canceled or synced build workflow

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend