Actions14
Update Playbook Pipeline
AI-generatedOverview
This node operation updates a playbook pipeline in the HumanFirst platform. It is designed to modify specific fields of a pipeline, primarily the date filter to the current day, based on a provided update mask. This operation is useful for automating updates to pipeline configurations, such as refreshing date ranges for data queries within a playbook pipeline.
Use Case Examples
- Automatically update the date filter of a playbook pipeline to today's date before running a data extraction workflow.
- Modify specific fields in a pipeline's configuration to reflect new query predicates or parameters as part of a scheduled update process.
Properties
| Name | Meaning |
|---|---|
| Update Mask (Comma-Separated) | Comma-separated list of pipeline fields to update, e.g., steps.dataQuery.queries.query.predicates. This defines which parts of the pipeline configuration will be updated. The default and currently only supported field is the date filter predicates. |
| Apply To All Steps? | Boolean flag indicating whether to apply the update to all matching items in the payload or only those specified in the update mask. |
| Namespace | The namespace under which the playbook exists. Required to identify the playbook context for the update. |
| Playbook ID | The unique identifier of the playbook containing the pipeline to update. |
| Pipeline ID | The unique identifier of the pipeline within the playbook to update. |
Output
JSON
json- The JSON response from the HumanFirst API after updating the playbook pipeline, containing the updated pipeline details or status.
Dependencies
- HumanFirst API key credential
Troubleshooting
- Ensure the update_mask parameter is a non-empty comma-separated list of valid field paths; otherwise, the node throws an error.
- Verify that the namespace, playbookId, and pipelineId are correctly specified and exist in the HumanFirst platform.
- Check API key credentials for proper authorization to perform updates on the playbook pipeline.
- If the update does not apply as expected, confirm that the update_mask fields are supported and correctly formatted.