Actions10
Get Records
AI-generatedOverview
This node interacts with the Blue Project Management system via its GraphQL API to retrieve records from a specified company and optionally a project. It supports searching records by a search term, filtering by completion status, and pagination through limit and skip parameters. This operation is useful for users who want to fetch project management data such as tasks or records for reporting, automation, or integration with other systems.
Use Case Examples
- Fetch up to 50 incomplete records from a specific project within a company to display in a dashboard.
- Search for records containing the term 'Halaxy Create Patient' across a company's projects to find relevant tasks.
- Retrieve records with pagination by skipping the first 100 records and limiting the next fetch to 50 records.
Properties
| Name | Meaning |
|---|---|
| Company | The company containing the records or projects to query. This is required to scope the data retrieval. |
| Project | The project to work with. Optional for getting records but required for other operations. Can be selected from a list or specified by ID. |
| Search Term | Optional text to search for within records to filter results. |
| Show Completed | Boolean flag to include completed records in the results. |
| Limit | Maximum number of records to return in the response. |
| Skip | Number of records to skip for pagination purposes. |
| Additional Options | Additional optional settings such as request timeout and whether to return the full GraphQL response including errors and extensions. |
Output
JSON
json- The retrieved records data from Blue Project Management API.
Dependencies
- Requires an API key credential for Blue Project Management API authentication.
Troubleshooting
- Common issues include GraphQL errors returned from the API, which are surfaced as error messages in the node output.
- If the company or project ID is missing or invalid, the node will return an error indicating the need to select a valid company or project.
- Timeouts can occur if the API request takes too long; adjusting the timeout setting in additional options may help.
- Errors during HTTP requests or authentication failures will throw errors; ensure the API key credential is correctly configured.
Links
- Blue Project Management GraphQL API - Official API documentation for Blue Project Management used by the node.