workflows

Creates, updates, deletes, gets or lists a workflows resource.

Overview

Name	workflows
Type	Resource
Id	datadog.software_delivery.workflows

Fields

The following fields are returned by SELECT queries:

get_workflow

Successfully got a workflow.

Name	Datatype	Description
id	string	The workflow identifier
attributes	object	The definition of WorkflowDataAttributes object.
relationships	object	The definition of WorkflowDataRelationships object.
type	string	The definition of WorkflowDataType object. (example: workflows)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow	select	workflow_id, region		Get a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.
create_workflow	insert	region, data__data		Create a new workflow, returning the workflow ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.
update_workflow	update	workflow_id, region, data__data		Update a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.
delete_workflow	delete	workflow_id, region		Delete a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	(default: datadoghq.com)
workflow_id	string	The ID of the workflow.

SELECT examples

get_workflow

Get a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

SELECT
id,
attributes,
relationships,
type
FROM datadog.software_delivery.workflows
WHERE workflow_id = '{{ workflow_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_workflow

Create a new workflow, returning the workflow ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

INSERT INTO datadog.software_delivery.workflows (
data__data,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: workflows
  props:
    - name: region
      value: string
      description: Required parameter for the workflows resource.
    - name: data
      value: object
      description: |
        Data related to the workflow.

UPDATE examples

update_workflow

Update a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

UPDATE datadog.software_delivery.workflows
SET 
data__data = '{{ data }}'
WHERE 
workflow_id = '{{ workflow_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_workflow

Delete a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

DELETE FROM datadog.software_delivery.workflows
WHERE workflow_id = '{{ workflow_id }}' --required
AND region = '{{ region }}' --required
;