Method StartFileTransaction
StartFileTransaction(String, String, String, String, String, String, Boolean)
Starting a new file transaction. Download the file with the method GetTempFile. Call ReleaseFile to end transaction.
Declaration
string StartFileTransaction(string connectionId, string documentId, string versionId, string documentDataId, string renditionId, string accessTypeEnum, bool ignoreHashValidation)
Parameters
Type | Name | Description |
---|---|---|
System.String | connectionId | The connection id to identify your connection. See also ConnectionId |
System.String | documentId | The document id. See also Id |
System.String | versionId | Optional: The version id. See also GetVersionListItems(String, String, Int32, Int32) |
System.String | documentDataId | Optional: The document data id. See also DocumentData |
System.String | renditionId | Optional: The rendition id. See also DocumentData |
System.String | accessTypeEnum | Optional: Type of access AccessTypeEnum |
System.Boolean | ignoreHashValidation | Ignore system configuration for hash validation |
Returns
Type | Description |
---|---|
System.String | Return a file id. |
Examples
POST http://YourServerName/InfoShare/Json/File/StartFileTransaction
A simple example for start file transaction.{
"connectionId": "bbf760ba-6bdb-45b6-9eec-992669fc7359",
"documentId": "653fa7fd-f6dd-e911-a947-00155d290a08",
"versionId": "653fa7fd-f6dd-e911-a947-00155d290a08",
"documentDataId": "",
"renditionId": "",
"ignoreHashValidation": false
}
Example for start file transaction with options parameter.
{
"connectionId": "bbf760ba-6bdb-45b6-9eec-992669fc7359",
"documentId": "653fa7fd-f6dd-e911-a947-00155d290a08",
"versionId": "653fa7fd-f6dd-e911-a947-00155d290a08",
"documentDataId": "663fa7fe-f6dd-e911-a947-00166d290a08",
"renditionId": "753ga7fd-f6dd-e911-a947-00178d290a08",
"ignoreHashValidation": false
}
Response:
"GetStartFileTransactionResult": "17820e29-11ee-4890-8648-3463dd0b5418"
Exceptions
Type | Condition |
---|---|
ServiceException | The connection id {connectionId} isn't valid or has expired (10008) |
ServiceException | Document without file {documentId} (10004) |
ServiceException | No document found for documentId {documentId} (10005) |
ServiceException | Not enough rights ({accessOperationName}, {accessOperationId}) (10071) |
ServiceException | Could not retrieve version {versionId} for document {documentId} (10130) |
ServiceException | Verification code is needed: Verification code not yet verified (10152) |
ServiceException | BlobStore {blobStoreId} is not available (10171) |
ServiceException | Could not get file stream: {errorMessage} (10172) |