Actions52
- Project Actions
- Project Photo Actions
- Project Collaborator Actions
- Project Document Actions
- Project User Actions
- Project Label Actions
- Project Checklist Actions
- User Actions
- Photo Actions
- Tag Actions
- Group Actions
- Other Actions
Overview
The provided source code defines a custom n8n node named "CompanyCam" designed to interact with the CompanyCam API. This node supports multiple resources and operations related to project management, photos, collaborators, documents, users, labels, checklists, tags, groups, and other entities within CompanyCam.
Specifically for the Project Document resource and the Upload a Document operation, although the exact implementation details are not included in the snippet, the node is intended to allow users to upload documents associated with projects in CompanyCam. This functionality would be beneficial in scenarios where teams need to attach important files—such as contracts, plans, or reports—to specific projects for easy access and collaboration.
Practical examples include:
- Automatically uploading inspection reports to a project after completion.
- Attaching signed contracts or permits to relevant projects.
- Syncing documents from other systems into CompanyCam projects for centralized documentation.
Properties
| Name | Meaning |
|---|---|
| Resource | The type of entity you want to work with (e.g., Project Document). |
| Operation | The action to perform on the selected resource (e.g., Upload a Document). |
| Notice | Informational messages displayed in the UI indicating unimplemented parts or funding notes. |
Note: The provided properties JSON only contains notices indicating that some parts are not yet built and contact information, so no detailed input fields for uploading documents are shown here.
Output
The node outputs data in JSON format representing the result of the performed operation. For the "Upload a Document" operation under the "Project Document" resource, the output JSON would typically include metadata about the uploaded document such as:
- Document ID
- File name
- URL or path to the uploaded document
- Associated project ID
- Upload status or confirmation
If the node supports binary data output (e.g., returning the actual file content), it would be indicated separately, but this is not evident from the current source.
Dependencies
- Requires an active connection to the CompanyCam API.
- Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
- The base URL for API requests is
https://api.companycam.com/v2. - No additional external dependencies are visible in the provided code.
Troubleshooting
Common Issues:
- Missing or invalid API credentials will cause authentication failures.
- Attempting to use unimplemented operations may result in errors or notices indicating incomplete functionality.
- Network connectivity issues can prevent successful API calls.
Error Messages:
- Authentication errors typically indicate invalid or missing API keys; verify credentials in n8n settings.
- API response errors might include HTTP status codes and messages from CompanyCam; ensure the requested resource and operation are supported.
- Notices in the UI warn about features not yet implemented; these indicate that certain operations or resources are placeholders.
Links and References
- CompanyCam API Documentation
- n8n Documentation
- CompanyCam GitHub Repository (if available) (hypothetical link based on context)
Note: The source code mainly sets up the node structure and imports descriptions and operations from other modules. The actual logic for the "Upload a Document" operation is not present in the snippet, so the summary is based on typical usage patterns and standard API interaction expectations.