Scoro icon

Scoro

Interact with the Scoro API
Join our community

Actions50

Overview

This node interacts with the Scoro API to retrieve multiple comments associated with a specific module and object within that module. The "Get Many" operation under the "Comment" resource allows users to fetch a list of comments, optionally filtered by criteria such as modification date, and supports pagination and batching to handle large datasets efficiently.

Common scenarios where this node is beneficial include:

  • Aggregating all comments related to a particular task or project for reporting or analysis.
  • Synchronizing comments from Scoro into another system or database.
  • Monitoring recent comment activity on specific objects within Scoro.

For example, a project manager might use this node to pull all comments on a project to review team feedback, or an automation workflow could extract comments on tasks modified after a certain date to trigger notifications.

Properties

Name Meaning
Module The module to which the comment belongs. Examples include "tasks", "projects", etc. This determines the context of the comments being retrieved.
Object ID The unique identifier of the object within the specified module whose comments are to be fetched.
Filter A JSON object used to filter the results. For instance, filtering comments modified after a certain date. The JSON must be valid and follow the expected structure (e.g., { "modified_date": { "from_date": "2023-01-01" } }).
Include Deleted Boolean flag indicating whether to include comments that have been deleted in the last 30 days.
Return All Boolean option to return all matching comments or limit the number of results.
Page Limit When not returning all, specifies the maximum number of comments to return. Minimum value is 1, default is 50.
Pages per Batch Number of pages to request concurrently in each batch to avoid hitting rate limits. Minimum value is 1, default is 20.
Batch Interval Time in milliseconds to wait between each batch of requests to manage rate limiting. Default is 1000 ms.

Output

The node outputs an array of comment objects in the json field of the output data. Each comment object typically includes details such as the comment text, author, timestamps, and metadata related to the comment's association with the specified module and object.

If binary data were involved (not indicated here), it would be summarized accordingly, but this operation focuses on JSON comment data.

Dependencies

  • Requires an active connection to the Scoro API via an API key credential.
  • The node expects configuration of the base URL and authentication credentials for Scoro.
  • No additional external dependencies beyond the Scoro API and n8n's HTTP request capabilities.

Troubleshooting

  • Invalid Operation or Resource: If the selected operation or resource is unsupported, the node throws an error indicating the unsupported combination. Ensure "Comment" resource and "Get Many" operation are selected.
  • Malformed Filter JSON: Providing invalid JSON in the filter property will cause parsing errors. Validate JSON syntax before input.
  • API Rate Limits: Fetching large numbers of comments without proper batching or intervals may hit API rate limits. Adjust "Pages per Batch" and "Batch Interval" settings to mitigate.
  • Missing or Incorrect Credentials: Authentication failures occur if API keys or base URLs are incorrect or missing. Verify credentials in n8n settings.
  • Empty Results: If no comments match the filter or object ID, the output will be empty. Confirm the object ID and filters are correct.

Links and References

Discussion