Actions10
List Custom Fields
AI-generatedOverview
This node operation lists custom fields for a specified project within a company in Blue Project Management. It is useful for retrieving metadata about custom fields that can be used to customize project records, such as field names, types, and options. For example, a user can list all custom fields in a project to dynamically build forms or reports based on those fields.
Use Case Examples
- Retrieve all custom fields for a project to display in a user interface.
- Fetch custom field metadata to validate input data before updating project records.
Properties
| Name | Meaning |
|---|---|
| Company | The company containing the records/projects to query custom fields from. |
| Project | The project to work with; required to specify which project's custom fields to list. |
| Sort Order | How to sort the custom fields in the response, e.g., by name or creation date. |
| Skip | Number of custom fields to skip for pagination. |
| Take | Maximum number of custom fields to return (between 1 and 100). |
| Additional Options | Additional request options such as timeout and whether to return the full GraphQL response including errors and extensions. |
Output
JSON
json- The list of custom fields returned by the API, including field id, name, type, and optionally description and options.
Dependencies
- Blue Project Management API accessed via GraphQL with an API key credential
Troubleshooting
- Common issues include missing or invalid company or project IDs, which result in errors indicating that the company or project must be selected first.
- GraphQL errors may occur if the API request is malformed or if the API key is invalid or lacks permissions.
- Timeouts can happen if the request takes too long; increasing the timeout in additional options may help.
Links
- Blue Project Management GraphQL API Documentation - Official API documentation for Blue Project Management's GraphQL endpoints.