Sign in
steps

Suppress Step

Soft-delete a step. Deactivates its trigger if any.

post/api/v1/steps/{step_id}/suppress

Path parameters

step_idstring uuid required

Response

Successful Response

idstring uuid required
project_idstring uuid required
company_idstring uuid required
user_idstring uuid required
slugstring required
titlestring required
descriptionstring required
step_type'source' | 'data_read' | 'process' | 'data_sink' | 'database' | 'dashboard' required

The role a step plays in the project DAG.

code_type'python' | 'sql' required

Runtime language for the step code.

sink_target'database' required

Where a data_sink step writes its output.

provider_idstring uuid nullable required
parent_step_idsstring[] required
orderinteger required
code_urlstring required
in_formatstring required
out_formatstring required
referenced_database_idsstring[] required
referenced_entity_idsstring[]
input_schemaobject[] nullable required
operator_typestring nullable
operator_configobject nullable
extra_metadataobject nullable
entity_idstring uuid nullable
statusstring
is_suppressedboolean required
created_atstring date-time required
updated_atstring date-time required
database_namestring nullable

Changes

Changed in 1 of the 12 revisions of this API.1

  • 19f18f4ca1641See the full diff
    • ○

      added the optional property referenced_entity_ids to the response with the 200 status

      response-optional-property-added