Method StartFileTransactionFileConvertedAttachment
StartFileTransactionFileConvertedAttachment(String, String, String, String)
Starting a new file transaction for a converted attachment. Download the file with the method GetTempFile. Call ReleaseFile to end transaction.
Declaration
FileTransactionResultContract StartFileTransactionFileConvertedAttachment(string connectionId, string fileId, string attachmentId, string targetFormat)
Parameters
Type | Name | Description |
---|---|---|
System.String | connectionId | The connection id to identify your connection. See also ConnectionId |
System.String | fileId | The file id. |
System.String | attachmentId | The attachment id. See also Attachments |
System.String | targetFormat | The target format (e.g. "pdf") |
Returns
Type | Description |
---|---|
FileTransactionResultContract | Return a file id. |
Examples
POST http://YourServerName/InfoShare/Json/File/StartFileTransactionFileConvertedAttachment
Example for start file transaction.{
"connectionId": "bbf760ba-6bdb-45b6-9eec-992669fc7359",
"documentId": "89dcf0ba-9c19-485b-bc0a-e8b5666866fa",
"attachmentId":"02c90715-040d-02c8-100a-c6020e05c502",
"targetFormat":"pdf"
}
Response:
{
"StartFileTransactionAttachmentResult": {
"AttachmentId": "02c90715-040d-02c8-100a-c6020e05c502",
"DocumentDataId": null,
"DocumentId": "null",
"FileId": "6550eff7-4225-4ee2-804b-d01b5b12b2b1",
"RenditionId": null,
"VersionId": null
}
}
Exceptions
Type | Condition |
---|---|
ServiceException | The connection id {connectionId} isn't valid or has expired (10008) |
ServiceException | Could not get file stream: {errorMessage} (10172) |
ServiceException | Attachment not found {attachmentId} (10267) |