Actions77
- Columns Actions
- Comments Actions
- Companies Actions
- Currencies Actions
- Document Anchors Actions
- List Document Anchor
- List Basket Document Anchor
- Count Basket Document Anchor
- Check Edited Document Anchor
- Get By Id Document Anchor
- Update Document Anchor
- Delete Document Anchor
- Get Versions Document Anchor
- Get History Document Anchor
- Rotate Document Anchor
- Split Document Anchor
- Reassign Document Anchor
- Reassign All Document Anchor
- Redetect Document Anchor
- Get File Document Anchor
- Get Symbolic Links Document Anchor
- Get Group Treatments Document Anchor
- Get Group Documents Document Anchor
- Count Without Template Document Anchor
- List Without Template Document Anchor
- Set Template Document Anchor
- Transition Document Anchor
- Get State Document Anchor
- Update State Document Anchor
- Annotations Actions
- Expenses Actions
- Expense Categories Actions
- Expense Projects Actions
- Expense Reports Actions
- External Attachments Actions
- Fields Actions
- Files Actions
- Groups Actions
- Pending Transaction Actions
- Taxes Actions
- Tax Groups Actions
- Templates Actions
- Template Types Actions
- Streams Actions
- Users Actions
- Viridem Actions
Annotations → Add Annotations Document Anchor
AI-generatedOverview
This node operation adds a document anchor with annotations to a specified company in the Viridem system. It is useful for scenarios where users need to attach annotated images or other content to documents within a company's records, such as marking up images or documents with additional information or highlights.
Use Case Examples
- Adding an image annotation to a document anchor for a specific company.
- Uploading base64-encoded images as annotations to a document anchor.
Properties
| Name | Meaning |
|---|---|
| Company Id | The unique identifier of the company to which the document anchor belongs. |
| Document Anchor Id | The unique identifier of the document anchor to which annotations will be added. |
| Use Defaults | A boolean flag indicating whether to use default settings for the annotation addition. |
| Creator Name | The name of the creator of the annotations, typically the user's full name or email. |
| Base 64 Urls | A JSON array of base64-encoded image URLs to be added as annotations. |
| Annotations | A JSON array of annotation objects containing content details such as content type and image attachment ID. |
| Request Options | Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration. |
Output
JSON
response- The response from the Viridem API after adding the annotations document anchor.
Dependencies
- Viridem API OAuth2 credentials for authentication
Troubleshooting
- Ensure that the Company Id and Document Anchor Id are valid and exist in the Viridem system to avoid errors.
- Verify that the base64 URLs and annotations JSON are correctly formatted to prevent parsing errors.
- Check network settings such as proxy and SSL options if requests fail due to connectivity issues.
- Timeout errors can occur if the server takes too long to respond; adjust the timeout setting accordingly.