Autentique icon

Autentique

Trabalhe com dados da API do Autentique para assinaturas digitais

Overview

The "Move to Folder" operation in the Document resource allows users to move a specific document to a designated folder within the Autentique digital signature platform. This operation is useful for organizing documents by categorizing them into personal, organizational, or group folders. It also supports removing a document from its current folder by specifying an empty destination folder ID.

Practical scenarios include:

  • Organizing signed contracts into project-specific folders.
  • Moving draft documents out of shared folders back to personal folders.
  • Reorganizing documents when team structures change, moving documents between group or organization folders.

Properties

Name Meaning
Document ID The unique identifier of the document to be moved.
Destination Folder ID The ID of the target folder where the document will be moved. Leave empty to remove folder association.
Current Folder ID The ID of the folder where the document currently resides. Required if the document is already in a folder.
Context The context of the folder: Personal (default), Organization, or Group folder.

Output

The output of this operation is the raw response from the API mutation moveDocumentToFolder. According to the GraphQL mutation, it returns a boolean indicating success or failure of the move operation.

The JSON output field will contain a single boolean value representing whether the document was successfully moved to the specified folder or removed from its folder.

No binary data is involved in this operation.

Example output JSON:

{
  "data": {
    "moveDocumentToFolder": true
  }
}

Dependencies

  • Requires an API key credential for authenticating with the Autentique API.
  • The node sends a POST request to the Autentique GraphQL endpoint at https://api.autentique.com.br/v2/graphql.
  • Proper permissions on the API key are necessary to modify document folder assignments.

Troubleshooting

  • Missing Document ID: The operation requires a valid Document ID. Ensure this property is set and corresponds to an existing document.
  • Invalid Folder IDs: If the current or destination folder IDs are incorrect or do not exist, the API may return an error or fail silently. Verify folder IDs before use.
  • Context Mismatch: Using an incorrect context (Personal, Organization, Group) might cause the move to fail if the folder does not belong to that context.
  • Permission Denied: Insufficient API permissions can cause authorization errors. Confirm the API key has rights to manage documents and folders.
  • Empty Destination Folder ID: Leaving the destination folder ID empty removes the document from any folder. Use this intentionally; otherwise, specify a valid folder ID.

Common error messages:

  • "Document not found": Check the Document ID.
  • "Folder not found": Verify folder IDs and context.
  • "Unauthorized": Check API credentials and permissions.

Links and References


This summary covers the static analysis of the "Move to Folder" operation for the Document resource based on the provided source code and properties.

Discussion