get_build_workflow_details¶
- ArtificialIntelligenceApi.get_build_workflow_details(policy_id, build_workflow_id, role_id, action=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Get build workflow details or export its document
Returns stored workflow details. Set action=export_document to receive a presigned GET URL for the workflow document instead.
- Parameters:
policy_id (str) – (required)
build_workflow_id (str) – (required)
role_id (str) – (required)
action (str) – Set to export_document to return a presigned download URL for the workflow document. Omit to return workflow details.
_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:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: GET /ai/reasoning-policies/{policy_id}/build-workflows/{build_workflow_id}
Success (HTTP 200)¶
Successfully returns build workflow details
Errors¶
HTTP 400
Invalid input
HTTP 500
Something went wrong at backend