CompanyCam icon

CompanyCam

Node for connecting CompanyCam

Overview

The node connects to the CompanyCam API, enabling interaction with various resources such as projects, photos, collaborators, documents, users, labels, checklists, and more. Specifically, for the Project Label resource and the Delete Label From Project operation, the node allows users to remove a label that has been assigned to a project within CompanyCam.

This functionality is useful in scenarios where project organization needs updating or cleanup, such as removing outdated or incorrect labels from projects to maintain accurate categorization and filtering.

Practical example:

  • A user wants to remove a specific label from a construction project after the phase associated with that label is completed, ensuring reports and views reflect current project status.

Properties

Name Meaning
Resource The type of entity to interact with; here it should be set to "Project Label".
Operation The action to perform on the resource; here it should be "Delete Label From Project".

Note: The provided properties JSON only contains notices indicating that some parts are not yet built and does not define explicit input parameters for this operation. Typically, for deleting a label from a project, you would expect inputs like:

  • Project ID (to identify the project)
  • Label ID (to specify which label to delete)

However, these are not explicitly defined in the provided code snippet.

Output

The output structure is not explicitly detailed in the provided source code. Generally, for a delete operation via an API:

  • The json output field would contain a confirmation of deletion, such as a success message or status code.
  • No binary data output is expected for this operation.

Dependencies

  • Requires an API key credential for authenticating with the CompanyCam API.
  • The base URL for API requests is https://api.companycam.com/v2.
  • The node depends on the CompanyCam API being available and accessible.

Troubleshooting

  • Common issues:

    • Missing or invalid API key will cause authentication failures.
    • Providing incorrect project or label IDs will result in errors such as "Label not found" or "Project not found".
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Authentication errors: Ensure the API key credential is correctly configured.
    • Not found errors: Verify that the project and label IDs exist and are correct.
    • Rate limiting or server errors: Retry after some time or check CompanyCam API status.

Links and References

Discussion