Kenesto API Documentation

Kenesto API

Test Retrieve Object Info Retrieve Documents Documents Quick Search Retrieve Checked Out Documents Retrieve Archived Documents Retrieve Shared Documents Retrieve Document History Retrieve Statistics Retrieve Number Of Documents Create Folder Edit Folder Update Asset Name Retrieve File Versions Delete Folder Delete Asset Check In Check Out Discard Check Out Check In Multiple Check Out Multiple Share Document Share Documents Share Folder Multi Select Share Download File Download File Version Upload File Upload File Completed Get Viewer Url Get Revision Viewer Url Add Dependencies Set Dependencies Update Dependencies Delete Dependencies By Ids Delete Dependencies Get Dependencies Get Dependents Get Independent Documents Get Documents With No Dependency Get Documents With No Dependents Download Dependencies Add Revision Delete Revision Get Revisions Download Revision Get Next Revision Code Add Save As History Event Add History Event Save As Lock File Unlock File Get Locked By User Is File Locked Create Document Sequence Number Create Document Sequence Number Ex Get Next Document Sequence Value Get Next Document Sequence Value Ex Get Current Document Sequence Number Get Current Document Sequence Number Ex Release Document Sequence Remove Document Sequence Get All Document Sequences Info Get All Document Sequences Info Ex Get Participant Permissions For Object Set Current File Version Attach Data Item Detach Data Item Get Document Path By Id Download Inline File Share Document2 Share Folder2 Freeze File Un Freeze File Unlock Multiple Composite Pdf File

Kenesto Documents API

Base URL
https://{kenesto-hostname}/Kenesto.Web.API/KDocumentsV3.svc/
POSTTest ▼

Runs a lightweight test call.

Parameters

Request Example

{ 
  "token": "encrypted-token-value", 
  "userData": "optional free text" 
}

Response Example

{ 
  "success": true, 
  "operation": "Test", 
  "message": "Test completed successfully.", 
  "data": { 
    "result": "ok" 
  }
POSTRetrieve Object Info ▼

Retrieve information for the requested object.

Parameters

Request Example




Response Example


{ 
  "success": true, 
  "operation": "RetrieveObjectInfo", 
  "message": "RetrieveObjectInfo completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTRetrieve Documents
▼







Retrieve a paged list of documents under the requested folder.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "pageSize": 25, 
  "pageNumber": 1, 
  "userData": "optional free text", 
  "sortBy": "Name", 
  "sortDirection": "asc", 
  "asOwner": false 
}



Response Example


{ 
  "success": true, 

  "operation": "RetrieveDocuments", 
  "message": "RetrieveDocuments completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTDocuments Quick Search
▼







Run a quick document search by keyword.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "keyword": "pump housing", 
  "pageSize": 25, 
  "pageNumber": 1, 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DocumentsQuickSearch", 
  "message": "DocumentsQuickSearch completed successfully.", 
  "data": { 
    "result": "ok" 
  }











POSTRetrieve Checked Out Documents
▼







Retrieve checked-out documents.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "pageSize": 25, 
  "pageNumber": 1, 
  "userData": "optional free text", 
  "sortBy": "Name", 
  "sortDirection": "asc" 
}



Response Example


{ 
  "success": true, 
  "operation": "RetrieveCheckedOutDocuments", 
  "message": "RetrieveCheckedOutDocuments completed successfully.", 
  "data": { 
    "items": [ 

      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTRetrieve Archived Documents
▼







Retrieve archived documents.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "pageSize": 25, 
  "pageNumber": 1, 
  "userData": "optional free text", 
  "sortBy": "Name", 
  "sortDirection": "asc" 
}



Response Example


{ 
  "success": true, 
  "operation": "RetrieveArchivedDocuments", 
  "message": "RetrieveArchivedDocuments completed successfully.", 
  "data": { 
    "items": [ 

      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTRetrieve Shared Documents
▼







Retrieve shared documents.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "pageSize": 25, 
  "pageNumber": 1, 
  "userData": "optional free text", 
  "sortBy": "Name", 
  "sortDirection": "asc", 
  "isParentVault": false 
}



Response Example


{ 
  "success": true, 

  "operation": "RetrieveSharedDocuments", 
  "message": "RetrieveSharedDocuments completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTRetrieve Document History
▼







Retrieve the document history log.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "RetrieveDocumentHistory", 
  "message": "RetrieveDocumentHistory completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTRetrieve Statistics
▼







Retrieve system statistics for a tenant.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "tenantId": 1000001, 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "RetrieveStatistics", 
  "message": "RetrieveStatistics completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTRetrieve Number Of Documents
▼







Retrieve the number of documents under a folder.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "RetrieveNumberOfDocuments", 
  "message": "RetrieveNumberOfDocuments completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTCreate Folder
▼







Create a new folder and optional subfolders in the system.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "parentFolderId": "11111111-1111-1111-1111-111111111111", 
  "folderName": "folderName-value", 
  "folderDescription": "folderDescription-value", 
  "folderKeyword": "pump housing", 
  "userData": "optional free text", 
  "isVault": false 
}



Response Example


{ 
  "success": true, 
  "operation": "CreateFolder", 
  "message": "CreateFolder completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTEdit Folder
▼







Edits an existing resource for folder.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "folderName": "folderName-value", 
  "folderDescription": "folderDescription-value", 
  "folderKeyword": "pump housing", 
  "userData": "optional free text", 
  "isVault": false, 
  "applyToSubFolders": false 
}



Response Example


{ 
  "success": true, 
  "operation": "EditFolder", 
  "message": "EditFolder completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTUpdate Asset Name
▼







Update the display name of an asset.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "doctId": "11111111-1111-1111-1111-111111111111", 
  "docName": "docName-value", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "UpdateAssetName", 
  "message": "UpdateAssetName completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTRetrieve File Versions
▼







Retrieve the available versions of a file.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "RetrieveFileVersions", 
  "message": "RetrieveFileVersions completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTDelete Folder
▼







Deletes the requested resource for folder.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DeleteFolder", 
  "message": "DeleteFolder completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTDelete Asset
▼







Delete the requested asset.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "assetId": "11111111-1111-1111-1111-111111111111", 
  "familyCode": "DOC", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DeleteAsset", 
  "message": "DeleteAsset completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTCheck In
▼







Checks a file or document into the system.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "asset": { 
    "id": "11111111-1111-1111-1111-111111111111", 
    "name": "sample-asset" 
  }



Response Example


{ 
  "success": true, 
  "operation": "CheckIn", 
  "message": "CheckIn completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTCheck Out
▼







Checks a file or document out of the system.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "CheckOut", 
  "message": "CheckOut completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTDiscard Check Out
▼







Discards the current check-out operation for check out.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DiscardCheckOut", 
  "message": "DiscardCheckOut completed successfully.", 
  "data": { 
    "result": "ok" 
  }











POSTCheck In Multiple
▼







Check in multiple documents in one request.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentIds": [ 
    "11111111-1111-1111-1111-111111111111", 
    "22222222-2222-2222-2222-222222222222" 
  ], 
  "asset": { 
    "id": "11111111-1111-1111-1111-111111111111", 
    "name": "sample-asset" 
  }



Response Example


{ 
  "success": true, 
  "operation": "CheckInMultiple", 
  "message": "CheckInMultiple completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTCheck Out Multiple
▼







Check out multiple documents in one request.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentIds": [ 
    "11111111-1111-1111-1111-111111111111", 
    "22222222-2222-2222-2222-222222222222" 
  ], 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "CheckOutMultiple", 
  "message": "CheckOutMultiple completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTShare Document
▼







Shares the requested resource with participants for document.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "asset": { 
    "id": "11111111-1111-1111-1111-111111111111", 
    "name": "sample-asset" 
  }



Response Example


{ 
  "success": true, 
  "operation": "ShareDocument", 
  "message": "ShareDocument completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTShare Documents
▼







Shares the requested resource with participants for documents.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "objectIds": [ 
    "11111111-1111-1111-1111-111111111111", 
    "22222222-2222-2222-2222-222222222222" 
  ], 
  "usersPermissions": [ 
    { 
      "userPermissions_apiId": "11111111-1111-1111-1111-111111111111" 
    }



Response Example


{ 
  "success": true, 
  "operation": "ShareDocuments", 
  "message": "ShareDocuments completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 

  }











POSTShare Folder
▼







Shares the requested resource with participants for folder.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folder": { 
    "id": "11111111-1111-1111-1111-111111111111", 
    "name": "sample-folder" 
  }



Response Example


{ 
  "success": true, 
  "operation": "ShareFolder", 
  "message": "ShareFolder completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTMulti Select Share
▼







Share multiple objects in one request.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "shareSchema": { 
    "objectIds": [ 
      "11111111-1111-1111-1111-111111111111" 
    ], 
    "usersPermissions": [ 
      { 
        "participantId": "11111111-1111-1111-1111-111111111111", 
        "permission": "Read" 
      }



Response Example


{ 
  "success": true, 
  "operation": "MultiSelectShare", 
  "message": "MultiSelectShare completed successfully.", 
  "data": { 
    "result": "ok" 
  }











POSTDownload File
▼







Generates or returns downloadable content for file.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "isExternal": false, 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DownloadFile", 
  "message": "DownloadFile completed successfully.", 
  "data": { 
    "url": "https://files.example.com/resource/123", 
    "result": "ok" 
  }











POSTDownload File Version
▼







Generates or returns downloadable content for file version.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "isExternal": false, 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DownloadFileVersion", 
  "message": "DownloadFileVersion completed successfully.", 
  "data": { 
    "url": "https://files.example.com/resource/123", 
    "result": "ok" 
  }











POSTUpload File
▼







Uploads a file or finalizes an upload operation for file.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "UploadFile", 
  "message": "UploadFile completed successfully.", 
  "data": { 
    "url": "https://files.example.com/resource/123", 
    "result": "ok" 
  }











POSTUpload File Completed
▼







Complete a previously started upload operation.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "url": "https://storage.example.com/upload/123", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "UploadFileCompleted", 
  "message": "UploadFileCompleted completed successfully.", 
  "data": { 
    "url": "https://files.example.com/resource/123", 
    "result": "ok" 
  }











POSTGet Viewer Url
▼







Return a viewer URL for the requested file.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetViewerUrl", 
  "message": "GetViewerUrl completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTGet Revision Viewer Url
▼







Return a viewer URL for the requested revision.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "revisionId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetRevisionViewerUrl", 
  "message": "GetRevisionViewerUrl completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTAdd Dependencies
▼







Adds a new record or relationship for dependencies.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "AddDependencies", 

User's encrypted and 
encoded session token. 

Dependent document 
identifier. 

Collection of 
dependency target 
objects. 

Client key used to 
correlate requests. 
Default value: new 
Guid(). 

User data - free text. 
Default value: null. 

  "message": "AddDependencies completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTSet Dependencies
▼







Sets or replaces the requested value for dependencies.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "SetDependencies", 

User's encrypted and 
encoded session token. 

Dependent document 
identifier. 

Collection of 
dependency target 
objects. 

Client key used to 
correlate requests. 
Default value: new 
Guid(). 

User data - free text. 
Default value: null. 

  "message": "SetDependencies completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTUpdate Dependencies
▼







Updates an existing resource for dependencies.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "dependenciesInfo": [ 
    { 
      "dependencyObjectInfoId": "11111111-1111-1111-1111-111111111111" 
    }



Response Example


{ 
  "success": true, 
  "operation": "UpdateDependencies", 
  "message": "UpdateDependencies completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTDelete Dependencies By Ids
▼







Deletes the requested resource for dependencies by ids.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "DeleteDependenciesByIds", 
  "message": "DeleteDependenciesByIds completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTDelete Dependencies
▼







Deletes the requested resource for dependencies.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "DeleteDependencies", 
  "message": "DeleteDependencies completed successfully.", 
  "data": { 

    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTGet Dependencies
▼







Returns data from the system for dependencies.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "GetDependencies", 
  "message": "GetDependencies completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 

      }











POSTGet Dependents
▼







Returns data from the system for dependents.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "GetDependents", 
  "message": "GetDependents completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 

      }











POSTGet Independent Documents
▼







Returns data from the system for independent documents.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "fileExtension": "fileExtension-value", 
  "level": "all", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetIndependentDocuments", 
  "message": "GetIndependentDocuments completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTGet Documents With No Dependency
▼







Retrieve documents with no dependencies.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "fileExtension": "fileExtension-value", 
  "level": "all", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetDocumentsWithNoDependency", 
  "message": "GetDocumentsWithNoDependency completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 

      }











POSTGet Documents With No Dependents
▼







Retrieve documents that no other files depend on.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "folderId": "11111111-1111-1111-1111-111111111111", 
  "fileExtension": "fileExtension-value", 
  "level": "all", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetDocumentsWithNoDependents", 
  "message": "GetDocumentsWithNoDependents completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 

      }











POSTDownload Dependencies
▼







Generate a downloadable package of a file and its dependencies.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DownloadDependencies", 
  "message": "DownloadDependencies completed successfully.", 
  "data": { 
    "url": "https://files.example.com/resource/123", 
    "result": "ok" 
  }











POSTAdd Revision
▼







Adds a new record or relationship for revision.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentId": "11111111-1111-1111-1111-111111111111", 
  "comments": "Created from API documentation sample.", 
  "revCode": "revCode-value", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "AddRevision", 
  "message": "AddRevision completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTDelete Revision
▼







Deletes the requested resource for revision.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "revisionIds": [ 
    "11111111-1111-1111-1111-111111111111", 
    "22222222-2222-2222-2222-222222222222" 
  ], 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DeleteRevision", 
  "message": "DeleteRevision completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTGet Revisions
▼







Returns data from the system for revisions.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "GetRevisions", 
  "message": "GetRevisions completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTDownload Revision
▼







Generates or returns downloadable content for revision.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "revisionId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DownloadRevision", 
  "message": "DownloadRevision completed successfully.", 
  "data": { 
    "url": "https://files.example.com/resource/123", 
    "result": "ok" 
  }











POSTGet Next Revision Code
▼







Return the next revision code for a document.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetNextRevisionCode", 
  "message": "GetNextRevisionCode completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTAdd Save As History Event
▼







Adds a new record or relationship for save as history event.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "objectId": "11111111-1111-1111-1111-111111111111", 
  "saveAsName": "copy.pdf", 
  "saveAsPath": "C:\\Temp\\sample.pdf", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "AddSaveAsHistoryEvent", 
  "message": "AddSaveAsHistoryEvent completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTAdd History Event Save As
▼







Add a Save As history event.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "objectId": "11111111-1111-1111-1111-111111111111", 
  "saveAsName": "copy.pdf", 
  "saveAsPath": "C:\\Temp\\sample.pdf", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "AddHistoryEventSaveAs", 
  "message": "AddHistoryEventSaveAs completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTLock File
▼







Locks the requested file or resource for file.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "LockFile", 
  "message": "LockFile completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTUnlock File
▼







Unlocks the requested file or resource for file.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "UnlockFile", 
  "message": "UnlockFile completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTGet Locked By User
▼







Return the user who currently holds the lock for the file.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetLockedByUser", 
  "message": "GetLockedByUser completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTIs File Locked
▼







Return whether the file is currently locked.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "IsFileLocked", 
  "message": "IsFileLocked completed successfully.", 
  "data": { 
    "value": true 
  }











POSTCreate Document Sequence Number
▼







Create a document sequence definition.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "sequenceName": "DOC", 
  "sequencePrefix": "DOC", 
  "sequenceNumber": 1, 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "CreateDocumentSequenceNumber", 
  "message": "CreateDocumentSequenceNumber completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTCreate Document Sequence Number  Ex
▼







Create a document sequence definition (extended version).
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "sequenceName": "DOC", 
  "sequencePrefix": "DOC", 
  "sequenceNumber": "DOC", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "CreateDocumentSequenceNumberEx", 
  "message": "CreateDocumentSequenceNumberEx completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTGet Next Document Sequence Value
▼







Return the next sequence value.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "sequenceName": "DOC", 
  "replacementSequencePrefix": "DOC", 
  "replacementSequenceNumber": "DOC", 
  "isLock": false, 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetNextDocumentSequenceValue", 
  "message": "GetNextDocumentSequenceValue completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTGet Next Document Sequence Value  Ex
▼







Return the next sequence value (extended version).
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "sequenceName": "DOC", 
  "replacementSequencePrefix": "DOC", 
  "replacementSequenceNumber": "DOC", 
  "isLock": false, 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetNextDocumentSequenceValueEx", 

  "message": "GetNextDocumentSequenceValueEx completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTGet Current Document Sequence Number
▼







Return the current sequence number.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "sequenceName": "DOC", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetCurrentDocumentSequenceNumber", 
  "message": "GetCurrentDocumentSequenceNumber completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTGet Current Document Sequence Number  Ex
▼







Return the current sequence number (extended version).
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "sequenceName": "DOC", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetCurrentDocumentSequenceNumberEx", 
  "message": "GetCurrentDocumentSequenceNumberEx completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTRelease Document Sequence
▼







Releases the requested lock or sequence for document sequence.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "sequenceName": "DOC", 
  "replacementSequencePrefix": "DOC", 
  "replacementSequenceNumber": "DOC", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "ReleaseDocumentSequence", 
  "message": "ReleaseDocumentSequence completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTRemove Document Sequence
▼







Removes the requested resource for document sequence.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "sequenceName": "DOC", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "RemoveDocumentSequence", 
  "message": "RemoveDocumentSequence completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTGet All Document Sequences Info
▼







Return information about all document sequences.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetAllDocumentSequencesInfo", 
  "message": "GetAllDocumentSequencesInfo completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTGet All Document Sequences Info  Ex
▼







Return information about all document sequences (extended version).
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetAllDocumentSequencesInfoEx", 
  "message": "GetAllDocumentSequencesInfoEx completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTGet Participant Permissions For Object
▼







Return the participant permissions for an object.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "GetParticipantPermissionsForObject", 
  "message": "GetParticipantPermissionsForObject completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTSet Current File Version
▼







Set the current file version.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "SetCurrentFileVersion", 
  "message": "SetCurrentFileVersion completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTAttach Data Item
▼







Attaches the requested item for data item.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "objectId": "11111111-1111-1111-1111-111111111111", 
  "attachedItemId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "AttachDataItem", 
  "message": "AttachDataItem completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTDetach Data Item
▼







Detaches the requested item for data item.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "objectId": "11111111-1111-1111-1111-111111111111", 
  "attachedItemId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "DetachDataItem", 
  "message": "DetachDataItem completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTGet Document Path By Id
▼







Return the document path for the supplied document ID.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "GetDocumentPathById", 
  "message": "GetDocumentPathById completed successfully.", 
  "data": { 
    "items": [ 
      { 
        "id": "11111111-1111-1111-1111-111111111111", 
        "name": "Sample" 
      }











POSTDownload Inline File
▼







Download a file inline.
 


Parameters




Request Example





Response Example


{ 
  "success": true, 
  "operation": "DownloadInlineFile", 
  "message": "DownloadInlineFile completed successfully.", 
  "data": { 
    "url": "https://files.example.com/resource/123", 
    "result": "ok" 
  }











POSTShare Document2
▼







Share a document with one or more participants.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "objectId": "11111111-1111-1111-1111-111111111111", 
  "UsersPermissions": [ 
    { 
      "userPermissions_apiId": "11111111-1111-1111-1111-111111111111" 
    }



Response Example


{ 
  "success": true, 
  "operation": "ShareDocument2", 
  "message": "ShareDocument2 completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTShare Folder2
▼







Share a folder with one or more participants.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "objectId": "11111111-1111-1111-1111-111111111111", 
  "UsersPermissions": [ 
    { 
      "userPermissions_apiId": "11111111-1111-1111-1111-111111111111" 
    }



Response Example


{ 
  "success": true, 
  "operation": "ShareFolder2", 
  "message": "ShareFolder2 completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTFreeze File
▼







Freezes the requested file for file.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "FreezeFile", 
  "message": "FreezeFile completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTUn Freeze File
▼







Unfreezes the requested file for file.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "UnFreezeFile", 
  "message": "UnFreezeFile completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTUnlock Multiple
▼







Unlock multiple documents in one request.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "documentIds": [ 
    "11111111-1111-1111-1111-111111111111", 
    "22222222-2222-2222-2222-222222222222" 
  ], 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "UnlockMultiple", 
  "message": "UnlockMultiple completed successfully.", 
  "data": { 
    "result": "ok", 
    "id": "11111111-1111-1111-1111-111111111111" 
  }











POSTComposite Pdf File
▼







Composite PDF files according to the supplied options.
 


Parameters




Request Example


{ 
  "token": "encrypted-token-value", 
  "fileId": "11111111-1111-1111-1111-111111111111", 
  "objectIdsToMerage": [ 

POST 

application/json 

Required 

Description 

Yes 

Yes 

Yes 

Yes 

Yes 

Yes 

Yes 

Yes 

Yes 

Yes 

Yes 

No 

User's encrypted and 
encoded session token. 

File identifier. 

List of object IDs to 
merge into the composite 
PDF. 

If true, split output 
according to the selected 
behavior. 

If true, keep superseded 
files. 

If true, reconsolidate files 
during composition. 

If true, analyze tables in 
the PDF content. 

If true, process sheet 
names only. 

If true, convert the output 
to vector PDF. 

If true, highlight 
searchable text. 

If true, override existing 
bookmarks. 

User data - free text. 
Default value: null. 

    "11111111-1111-1111-1111-111111111111", 
    "22222222-2222-2222-2222-222222222222" 
  ], 
  "split": false, 
  "keepSuperseded": false, 
  "reconsolidateFiles": false, 
  "analyzeTables": false, 
  "sheetNamesOnly": false, 
  "convertToVectorPdf": false, 
  "highlightSearchableText": false, 
  "overrideBookmarks": false, 
  "userData": "optional free text" 
}



Response Example


{ 
  "success": true, 
  "operation": "CompositePdfFile", 
  "message": "CompositePdfFile completed successfully.", 
  "data": { 
    "result": "ok" 
  }