- The Workflow API endpoints allow you to retrieve, manage, and track workflow playbooks and projects configured on the customer portal.
- Endpoints are available under Workflow APIs:
- /v4/workflows_playbooks – Returns a list of structured response plans (playbooks), including actions, descriptions, and categories.
- /v4/workflows_projects – Returns workflow execution data including linked events, sites, parts, progress, and responsible owners.
- Functionalities supported in these endpoints:
Feature | Description |
Filtering | Filter by status, projectId, projectName, start_date, end_date |
Pagination | Example: size=3&page=2 returns 2nd page with 3 records |
Sorting | Sort by playbookId or projectId in ascending/descending order |
Aggregation | Group data by fields such as playbookName using URL query: |
- Sample Use Cases:
- Retrieve all playbooks: /v4/workflows_playbooks
- Retrieve a specific project by ID:/v4/workflows_projects?projectId=12345
- Filter projects by status "Mitigating": /v4/workflows_projects?status=Mitigating
- Paginate playbooks (3 per page, page 2): /v4/workflows_playbooks?size=3&page=2
- Response Attributes briefly:
1. Playbooks Endpoint returns: playbookId, playbook_name, category, description, count_workflow_actions, actions[] (with action_name, action_description, default_owners), date_created, last_modified_date
2. Projects Endpoint returns: project_id, project_name, category, count_actions, owners[], status, start_date, end_date, priority, revenue_at_risk, actions[], and cross-linked entities like events, sites, partners, part categories, and comments
- User Can retrieve a specific project or playbook.
Example: - For a specific playbook:
/v4/workflows_playbooks?playbookId=1234 - For a specific project:
/v4/workflows_projects?projectId=5678
- A User can filter workflow projects by status and name as well.
Example queries: - Filter by status: /v4/workflows_projects?status=Mitigating
- Filter by project name:: /v4/workflows_projects?projectName=Special_Report
- Working of Pagination for playbooks and projects.
- Pagination is controlled using size (number of records) and page (page number)
Example: /v4/workflows_playbooks?size=3&page=2
This returns the second page of results with 3 records per page.
- Sorting of Results:
- Sorting is supported by appending .asc or .desc to the field name.
Examples:- Ascending: /v4/workflows_projects?sort=projectId.asc
- Descending: /v4/workflows_playbooks?sort=playbookId.desc
- Navigation to API documentation:
- Resilinc Portal → Help & Support → Customer Hub Login → Knowledge Base → REST APIs → FAQ
- Refer to Page 91 in the documentation for details on filtering and query formats.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article