Table of Contents

Class SchemaExtensions

Namespace
DocuWare.Platform.ServerClient
Assembly
DocuWare.Platform.ServerClient.dll

Extensions.

public static class SchemaExtensions
Inheritance
SchemaExtensions
Inherited Members

Methods

CreateUserDefinedSearchOperation(ServiceConnection, string, FunctionExpressionQuery, string[], string[], int?, int?)

public static Task<DeserializedHttpResponse<DocumentsQueryTableResult>> CreateUserDefinedSearchOperation(this ServiceConnection serviceConnection, string fileCabinetId, FunctionExpressionQuery data, string[] fields = null, string[] sortOrder = null, int? start = null, int? count = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
FunctionExpressionQuerydata
string[]fields
string[]sortOrder
int?start
int?count

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryTableResult>>

DeleteFromDocumentDeleteForStringAsync(ServiceConnection, int, string)

public static Task<DeserializedHttpResponse<string>> DeleteFromDocumentDeleteForStringAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

DeleteFromDocumentDeleteForStringAsync(ServiceConnection, CancellationToken, int, string)

public static Task<DeserializedHttpResponse<string>> DeleteFromDocumentDeleteForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

DeleteFromWorkflowInstanceForStringAsync(ServiceConnection, string, string)

public static Task<DeserializedHttpResponse<string>> DeleteFromWorkflowInstanceForStringAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringinstanceId

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

DeleteFromWorkflowInstanceForStringAsync(ServiceConnection, CancellationToken, string, string)

public static Task<DeserializedHttpResponse<string>> DeleteFromWorkflowInstanceForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringinstanceId

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

GetFromAnnotationForAnnotationAsync(ServiceConnection, string, string, int)

public static Task<DeserializedHttpResponse<Annotation>> GetFromAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

GetFromAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int)

public static Task<DeserializedHttpResponse<Annotation>> GetFromAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
stringfileCabinetId
intpage

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

GetFromAuditEventPropertiesForDocumentAuditEventInformationAsync(ServiceConnection, string, string)

public static Task<DeserializedHttpResponse<DocumentAuditEventInformation>> GetFromAuditEventPropertiesForDocumentAuditEventInformationAsync(this ServiceConnection serviceConnection, string fileCabinetId, string eventId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringeventId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentAuditEventInformation>>

GetFromAuditEventPropertiesForDocumentAuditEventInformationAsync(ServiceConnection, CancellationToken, string, string)

public static Task<DeserializedHttpResponse<DocumentAuditEventInformation>> GetFromAuditEventPropertiesForDocumentAuditEventInformationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string eventId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
stringeventId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentAuditEventInformation>>

GetFromClientSetupDataForXElementAsync(ServiceConnection, string, string, string)

public static Task<DeserializedHttpResponse<XElement>> GetFromClientSetupDataForXElementAsync(this ServiceConnection serviceConnection, string orgId, string baseAddress = null, string clientSetupVersion = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringorgId
stringbaseAddress
stringclientSetupVersion

Returns

TypeDescription
Task<DeserializedHttpResponse<XElement>>

GetFromClientSetupDataForXElementAsync(ServiceConnection, CancellationToken, string, string, string)

public static Task<DeserializedHttpResponse<XElement>> GetFromClientSetupDataForXElementAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string orgId, string baseAddress = null, string clientSetupVersion = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringorgId
stringbaseAddress
stringclientSetupVersion

Returns

TypeDescription
Task<DeserializedHttpResponse<XElement>>

GetFromControllerWorkflowDecisionsForDecisionAsync(ServiceConnection, string, string, string, int, bool?, bool?)

public static Task<DeserializedHttpResponse<Decision>> GetFromControllerWorkflowDecisionsForDecisionAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, int decisionId, bool? ignoreErrors = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringinstanceId
stringtaskId
intdecisionId
bool?ignoreErrors
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Decision>>

GetFromControllerWorkflowDecisionsForDecisionAsync(ServiceConnection, CancellationToken, string, string, string, int, bool?, bool?)

public static Task<DeserializedHttpResponse<Decision>> GetFromControllerWorkflowDecisionsForDecisionAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, int decisionId, bool? ignoreErrors = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringinstanceId
stringtaskId
intdecisionId
bool?ignoreErrors
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Decision>>

GetFromControllerWorkflowForWorkflowAsync(ServiceConnection, string, bool?)

public static Task<DeserializedHttpResponse<Workflow>> GetFromControllerWorkflowForWorkflowAsync(this ServiceConnection serviceConnection, string id, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Workflow>>

GetFromControllerWorkflowForWorkflowAsync(ServiceConnection, CancellationToken, string, bool?)

public static Task<DeserializedHttpResponse<Workflow>> GetFromControllerWorkflowForWorkflowAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Workflow>>

GetFromControllerWorkflowTaskForWorkflowTaskAsync(ServiceConnection, string, string, string, bool?, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTask>> GetFromControllerWorkflowTaskForWorkflowTaskAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, bool? loadColumnValues = null, bool? maintenanceMode = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringinstanceId
stringtaskId
bool?loadColumnValues
bool?maintenanceMode
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTask>>

GetFromControllerWorkflowTaskForWorkflowTaskAsync(ServiceConnection, CancellationToken, string, string, string, bool?, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTask>> GetFromControllerWorkflowTaskForWorkflowTaskAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, bool? loadColumnValues = null, bool? maintenanceMode = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringinstanceId
stringtaskId
bool?loadColumnValues
bool?maintenanceMode
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTask>>

GetFromControllerWorkflowTasksCountForWorkflowTasksCountAsync(ServiceConnection, string)

public static Task<DeserializedHttpResponse<WorkflowTasksCount>> GetFromControllerWorkflowTasksCountForWorkflowTasksCountAsync(this ServiceConnection serviceConnection, string id)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasksCount>>

GetFromControllerWorkflowTasksCountForWorkflowTasksCountAsync(ServiceConnection, CancellationToken, string)

public static Task<DeserializedHttpResponse<WorkflowTasksCount>> GetFromControllerWorkflowTasksCountForWorkflowTasksCountAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasksCount>>

GetFromControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, string, string[], int?, int?, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTasks>> GetFromControllerWorkflowTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, string id, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
string[]sortOrder
int?start
int?count
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasks>>

GetFromControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, string, string[], int?, int?, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTasks>> GetFromControllerWorkflowTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
string[]sortOrder
int?start
int?count
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasks>>

GetFromControllerWorkflowsForWorkflowsAsync(ServiceConnection, bool?)

public static Task<DeserializedHttpResponse<Workflows>> GetFromControllerWorkflowsForWorkflowsAsync(this ServiceConnection serviceConnection, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Workflows>>

GetFromControllerWorkflowsForWorkflowsAsync(ServiceConnection, CancellationToken, bool?)

public static Task<DeserializedHttpResponse<Workflows>> GetFromControllerWorkflowsForWorkflowsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Workflows>>

GetFromCountResultForCountResultAsync(ServiceConnection, string, string, string, int?)

public static Task<DeserializedHttpResponse<CountResult>> GetFromCountResultForCountResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string dialogId, string fieldName = null, int? limit = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringdialogId
stringfieldName
int?limit

Returns

TypeDescription
Task<DeserializedHttpResponse<CountResult>>

GetFromCountResultForCountResultAsync(ServiceConnection, CancellationToken, string, string, string, int?)

public static Task<DeserializedHttpResponse<CountResult>> GetFromCountResultForCountResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string dialogId, string fieldName = null, int? limit = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
stringdialogId
stringfieldName
int?limit

Returns

TypeDescription
Task<DeserializedHttpResponse<CountResult>>

GetFromCountTrashedDocumentsForCountResultAsync(ServiceConnection)

public static Task<DeserializedHttpResponse<CountResult>> GetFromCountTrashedDocumentsForCountResultAsync(this ServiceConnection serviceConnection)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection

Returns

TypeDescription
Task<DeserializedHttpResponse<CountResult>>

GetFromDialogForDialogAsync(ServiceConnection, string, string, DialogTypes[])

public static Task<DeserializedHttpResponse<Dialog>> GetFromDialogForDialogAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, DialogTypes[] dialogType = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
DialogTypes[]dialogType

Returns

TypeDescription
Task<DeserializedHttpResponse<Dialog>>

GetFromDialogForDialogAsync(ServiceConnection, CancellationToken, string, string, DialogTypes[])

public static Task<DeserializedHttpResponse<Dialog>> GetFromDialogForDialogAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, DialogTypes[] dialogType = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
stringfileCabinetId
DialogTypes[]dialogType

Returns

TypeDescription
Task<DeserializedHttpResponse<Dialog>>

GetFromDialogsByFileCabinetForDialogInfosAsync(ServiceConnection, string, DialogTypes[])

public static Task<DeserializedHttpResponse<DialogInfos>> GetFromDialogsByFileCabinetForDialogInfosAsync(this ServiceConnection serviceConnection, string fileCabinetId, DialogTypes[] dialogType = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
DialogTypes[]dialogType

Returns

TypeDescription
Task<DeserializedHttpResponse<DialogInfos>>

GetFromDialogsByFileCabinetForDialogInfosAsync(ServiceConnection, CancellationToken, string, DialogTypes[])

public static Task<DeserializedHttpResponse<DialogInfos>> GetFromDialogsByFileCabinetForDialogInfosAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, DialogTypes[] dialogType = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
DialogTypes[]dialogType

Returns

TypeDescription
Task<DeserializedHttpResponse<DialogInfos>>

GetFromDialogsForDialogInfosAsync(ServiceConnection, DialogTypes[])

public static Task<DeserializedHttpResponse<DialogInfos>> GetFromDialogsForDialogInfosAsync(this ServiceConnection serviceConnection, DialogTypes[] dialogType = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
DialogTypes[]dialogType

Returns

TypeDescription
Task<DeserializedHttpResponse<DialogInfos>>

GetFromDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, int, string)

public static Task<DeserializedHttpResponse<DocumentAnnotations>> GetFromDocumentAnnotationsForDocumentAnnotationsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentAnnotations>>

GetFromDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, CancellationToken, int, string)

public static Task<DeserializedHttpResponse<DocumentAnnotations>> GetFromDocumentAnnotationsForDocumentAnnotationsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentAnnotations>>

GetFromDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(ServiceConnection, int, string)

public static Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetFromDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentApplicationProperties>>

GetFromDocumentAuditInformationForDocumentAuditInformationAsync(ServiceConnection, string, int, DateTime?, DateTime?, string, int?, int?, string, string, bool?)

public static Task<DeserializedHttpResponse<DocumentAuditInformation>> GetFromDocumentAuditInformationForDocumentAuditInformationAsync(this ServiceConnection serviceConnection, string fileCabinetId, int id, DateTime? fromDate = null, DateTime? toDate = null, string format = null, int? start = null, int? count = null, string fcName = null, string delimiter = null, bool? isUtc = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
intid
DateTime?fromDate
DateTime?toDate
stringformat
int?start
int?count
stringfcName
stringdelimiter
bool?isUtc

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentAuditInformation>>

GetFromDocumentAuditInformationForDocumentAuditInformationAsync(ServiceConnection, CancellationToken, string, int, DateTime?, DateTime?, string, int?, int?, string, string, bool?)

public static Task<DeserializedHttpResponse<DocumentAuditInformation>> GetFromDocumentAuditInformationForDocumentAuditInformationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, int id, DateTime? fromDate = null, DateTime? toDate = null, string format = null, int? start = null, int? count = null, string fcName = null, string delimiter = null, bool? isUtc = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
intid
DateTime?fromDate
DateTime?toDate
stringformat
int?start
int?count
stringfcName
stringdelimiter
bool?isUtc

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentAuditInformation>>

GetFromDocumentContentForStreamAsync(ServiceConnection, int, string, int[])

public static Task<DeserializedHttpResponse<Stream>> GetFromDocumentContentForStreamAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, int[] append = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
int[]append

Returns

TypeDescription
Task<DeserializedHttpResponse<Stream>>

GetFromDocumentDocumentLinksForDocumentLinksAsync(ServiceConnection, int, string)

public static Task<DeserializedHttpResponse<DocumentLinks>> GetFromDocumentDocumentLinksForDocumentLinksAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentLinks>>

GetFromDocumentDocumentLinksForDocumentLinksAsync(ServiceConnection, CancellationToken, int, string)

public static Task<DeserializedHttpResponse<DocumentLinks>> GetFromDocumentDocumentLinksForDocumentLinksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentLinks>>

GetFromDocumentForDocumentAsync(ServiceConnection, int, string)

public static Task<DeserializedHttpResponse<Document>> GetFromDocumentForDocumentAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

GetFromDocumentForDocumentAsync(ServiceConnection, CancellationToken, int, string)

public static Task<DeserializedHttpResponse<Document>> GetFromDocumentForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

GetFromDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> GetFromDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

GetFromDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> GetFromDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

GetFromDocumentLatestVersionForDocumentAsync(ServiceConnection, int, string)

public static Task<DeserializedHttpResponse<Document>> GetFromDocumentLatestVersionForDocumentAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

GetFromDocumentTableFieldRowsForDocumentIndexFieldTableAsync(ServiceConnection, int, string, string, int?, int?)

public static Task<DeserializedHttpResponse<DocumentIndexFieldTable>> GetFromDocumentTableFieldRowsForDocumentIndexFieldTableAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, string tableFieldName, int? start = null, int? count = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
stringtableFieldName
int?start
int?count

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFieldTable>>

GetFromDocumentsFileDownloadForStreamAsync(ServiceConnection, int, string, FileDownloadType?, bool?, bool?, bool?, int[], int[])

public static Task<DeserializedHttpResponse<Stream>> GetFromDocumentsFileDownloadForStreamAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, FileDownloadType? targetFileType = null, bool? keepAnnotations = null, bool? downloadFile = null, bool? autoPrint = null, int[] layers = null, int[] append = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
FileDownloadType?targetFileType
bool?keepAnnotations
bool?downloadFile
bool?autoPrint
int[]layers
int[]append

Returns

TypeDescription
Task<DeserializedHttpResponse<Stream>>

GetFromDocumentsFileDownloadForStreamAsync(ServiceConnection, CancellationToken, int, string, FileDownloadType?, bool?, bool?, bool?, int[], int[])

public static Task<DeserializedHttpResponse<Stream>> GetFromDocumentsFileDownloadForStreamAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, FileDownloadType? targetFileType = null, bool? keepAnnotations = null, bool? downloadFile = null, bool? autoPrint = null, int[] layers = null, int[] append = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
FileDownloadType?targetFileType
bool?keepAnnotations
bool?downloadFile
bool?autoPrint
int[]layers
int[]append

Returns

TypeDescription
Task<DeserializedHttpResponse<Stream>>

GetFromDocumentsForDocumentsQueryResultAsync(ServiceConnection, string, string, string[], string[], int?, int?, int?, string, bool?, string, bool?, bool?)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> GetFromDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string q = null, string[] fields = null, string[] sortOrder = null, int? start = null, int? msStart = null, int? count = null, string format = null, bool? includeSuggestions = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? calculateTotalCount = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringq
string[]fields
string[]sortOrder
int?start
int?msStart
int?count
stringformat
bool?includeSuggestions
stringcsvDelimiter
bool?csvIsUtc
bool?calculateTotalCount

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

GetFromDocumentsForDocumentsQueryResultAsync(ServiceConnection, CancellationToken, string, string, string[], string[], int?, int?, int?, string, bool?)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> GetFromDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string q = null, string[] fields = null, string[] sortOrder = null, int? start = null, int? msStart = null, int? count = null, string format = null, bool? includeSuggestions = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
stringq
string[]fields
string[]sortOrder
int?start
int?msStart
int?count
stringformat
bool?includeSuggestions

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

GetFromFileCabinetForFileCabinetAsync(ServiceConnection, string)

public static Task<DeserializedHttpResponse<FileCabinet>> GetFromFileCabinetForFileCabinetAsync(this ServiceConnection serviceConnection, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<FileCabinet>>

GetFromFileCabinetForFileCabinetAsync(ServiceConnection, CancellationToken, string)

public static Task<DeserializedHttpResponse<FileCabinet>> GetFromFileCabinetForFileCabinetAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<FileCabinet>>

GetFromFileCabinetsForFileCabinetsAsync(ServiceConnection)

public static Task<DeserializedHttpResponse<FileCabinets>> GetFromFileCabinetsForFileCabinetsAsync(this ServiceConnection serviceConnection)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection

Returns

TypeDescription
Task<DeserializedHttpResponse<FileCabinets>>

GetFromFileCabinetsForFileCabinetsAsync(ServiceConnection, CancellationToken)

public static Task<DeserializedHttpResponse<FileCabinets>> GetFromFileCabinetsForFileCabinetsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken

Returns

TypeDescription
Task<DeserializedHttpResponse<FileCabinets>>

GetFromFunctionExpressionForDocumentsQueryTableResultAsync(ServiceConnection, string, string[], string[], int?, int?)

public static Task<DeserializedHttpResponse<DocumentsQueryTableResult>> GetFromFunctionExpressionForDocumentsQueryTableResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string[] fields = null, string[] sortOrder = null, int? start = null, int? count = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
string[]fields
string[]sortOrder
int?start
int?count

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryTableResult>>

GetFromIntellixSuggestionsForSuggestionFieldsAsync(ServiceConnection, int, string, bool?)

public static Task<DeserializedHttpResponse<SuggestionFields>> GetFromIntellixSuggestionsForSuggestionFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, bool? normalizeCoordinates = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
bool?normalizeCoordinates

Returns

TypeDescription
Task<DeserializedHttpResponse<SuggestionFields>>

GetFromIntellixSuggestionsForSuggestionFieldsAsync(ServiceConnection, CancellationToken, int, string, bool?)

public static Task<DeserializedHttpResponse<SuggestionFields>> GetFromIntellixSuggestionsForSuggestionFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, bool? normalizeCoordinates = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
bool?normalizeCoordinates

Returns

TypeDescription
Task<DeserializedHttpResponse<SuggestionFields>>

GetFromMultiColSelectListForMultiColSelectListInfoAsync(ServiceConnection, string)

public static Task<DeserializedHttpResponse<MultiColSelectListInfo>> GetFromMultiColSelectListForMultiColSelectListInfoAsync(this ServiceConnection serviceConnection, string selectListId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringselectListId

Returns

TypeDescription
Task<DeserializedHttpResponse<MultiColSelectListInfo>>

GetFromMultiColSelectListForMultiColSelectListInfoAsync(ServiceConnection, CancellationToken, string)

public static Task<DeserializedHttpResponse<MultiColSelectListInfo>> GetFromMultiColSelectListForMultiColSelectListInfoAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string selectListId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringselectListId

Returns

TypeDescription
Task<DeserializedHttpResponse<MultiColSelectListInfo>>

GetFromMultiColSelectListValuesForMultiColSelectListValuesResultAsync(ServiceConnection, string, int?, int?)

public static Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetFromMultiColSelectListValuesForMultiColSelectListValuesResultAsync(this ServiceConnection serviceConnection, string selectListId, int? start = null, int? count = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringselectListId
int?start
int?count

Returns

TypeDescription
Task<DeserializedHttpResponse<MultiColSelectListValuesResult>>

GetFromMultiColSelectListValuesForMultiColSelectListValuesResultAsync(ServiceConnection, CancellationToken, string, int?, int?)

public static Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetFromMultiColSelectListValuesForMultiColSelectListValuesResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string selectListId, int? start = null, int? count = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringselectListId
int?start
int?count

Returns

TypeDescription
Task<DeserializedHttpResponse<MultiColSelectListValuesResult>>

GetFromMultiColSelectListsForMultiColSelectListInfosAsync(ServiceConnection)

public static Task<DeserializedHttpResponse<MultiColSelectListInfos>> GetFromMultiColSelectListsForMultiColSelectListInfosAsync(this ServiceConnection serviceConnection)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection

Returns

TypeDescription
Task<DeserializedHttpResponse<MultiColSelectListInfos>>

GetFromMultiColSelectListsForMultiColSelectListInfosAsync(ServiceConnection, CancellationToken)

public static Task<DeserializedHttpResponse<MultiColSelectListInfos>> GetFromMultiColSelectListsForMultiColSelectListInfosAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken

Returns

TypeDescription
Task<DeserializedHttpResponse<MultiColSelectListInfos>>

GetFromPagesBlockForPagesAsync(ServiceConnection, string, string, int?, int?, bool?, string, bool?)

public static Task<DeserializedHttpResponse<Pages>> GetFromPagesBlockForPagesAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int? start = null, int? count = null, bool? embedThumbnailData = null, string thumbnailSize = null, bool? thumbnailsOnly = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
int?start
int?count
bool?embedThumbnailData
stringthumbnailSize
bool?thumbnailsOnly

Returns

TypeDescription
Task<DeserializedHttpResponse<Pages>>

GetFromPagesBlockForPagesAsync(ServiceConnection, CancellationToken, string, string, int?, int?, bool?, string, bool?)

public static Task<DeserializedHttpResponse<Pages>> GetFromPagesBlockForPagesAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int? start = null, int? count = null, bool? embedThumbnailData = null, string thumbnailSize = null, bool? thumbnailsOnly = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
stringfileCabinetId
int?start
int?count
bool?embedThumbnailData
stringthumbnailSize
bool?thumbnailsOnly

Returns

TypeDescription
Task<DeserializedHttpResponse<Pages>>

GetFromQueryDocumentsForDocumentsQueryResultAsync(ServiceConnection, string, string, string[], string[], int?, int?, string, string, string, string, bool?, bool?, bool?)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> GetFromQueryDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string q = null, string[] fields = null, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string additionalCabinets = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? includeSuggestions = null, bool? calculateTotalCount = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringq
string[]fields
string[]sortOrder
int?start
int?count
stringformat
stringadditionalCabinets
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?includeSuggestions
bool?calculateTotalCount

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

GetFromRequestTasksForRequestTasksAsync(ServiceConnection, int?, int?, string, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<RequestTasks>> GetFromRequestTasksForRequestTasksAsync(this ServiceConnection serviceConnection, int? start = null, int? count = null, string sortOrder = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
int?start
int?count
stringsortOrder
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<RequestTasks>>

GetFromRequestTasksForRequestTasksAsync(ServiceConnection, CancellationToken, int?, int?, string, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<RequestTasks>> GetFromRequestTasksForRequestTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int? start = null, int? count = null, string sortOrder = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
int?start
int?count
stringsortOrder
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<RequestTasks>>

GetFromSectionFileDownloadForStreamAsync(ServiceConnection, string, string, FileDownloadType?, bool?, bool?, bool?, bool?, int[])

public static Task<DeserializedHttpResponse<Stream>> GetFromSectionFileDownloadForStreamAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, FileDownloadType? targetFileType = null, bool? keepAnnotations = null, bool? downloadFile = null, bool? autoPrint = null, bool? sendByEmail = null, int[] layers = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
FileDownloadType?targetFileType
bool?keepAnnotations
bool?downloadFile
bool?autoPrint
bool?sendByEmail
int[]layers

Returns

TypeDescription
Task<DeserializedHttpResponse<Stream>>

GetFromSectionForSectionAsync(ServiceConnection, string, string, string, bool?)

public static Task<DeserializedHttpResponse<Section>> GetFromSectionForSectionAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, string thumbnailSize, bool? embedThumbnailData = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
stringthumbnailSize
bool?embedThumbnailData

Returns

TypeDescription
Task<DeserializedHttpResponse<Section>>

GetFromSectionPageForPageAsync(ServiceConnection, string, string, int)

public static Task<DeserializedHttpResponse<Page>> GetFromSectionPageForPageAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage

Returns

TypeDescription
Task<DeserializedHttpResponse<Page>>

GetFromSectionPositionsForWordSearchResultAsync(ServiceConnection, string, string, string, bool?, bool?, int?, int?, int?, bool?, bool?)

public static Task<DeserializedHttpResponse<WordSearchResult>> GetFromSectionPositionsForWordSearchResultAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, string q, bool? wholeWord = null, bool? ignoreCase = null, int? startSectionNumber = null, int? startPage = null, int? pageCount = null, bool? rangeSearch = null, bool? backward = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
stringq
bool?wholeWord
bool?ignoreCase
int?startSectionNumber
int?startPage
int?pageCount
bool?rangeSearch
bool?backward

Returns

TypeDescription
Task<DeserializedHttpResponse<WordSearchResult>>

GetFromSectionTextAnnotationForStringAsync(ServiceConnection, string, string, bool?)

public static Task<DeserializedHttpResponse<string>> GetFromSectionTextAnnotationForStringAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, bool? ignoreMe = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
bool?ignoreMe

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

GetFromSectionTextshotForDocumentContentAsync(ServiceConnection, string, string, bool?)

public static Task<DeserializedHttpResponse<DocumentContent>> GetFromSectionTextshotForDocumentContentAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, bool? skipNotExisting = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
bool?skipNotExisting

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentContent>>

GetFromSectionTextshotPageForPageContentAsync(ServiceConnection, string, string, int, bool?, bool?)

public static Task<DeserializedHttpResponse<PageContent>> GetFromSectionTextshotPageForPageContentAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, bool? flat = null, bool? normalize = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage
bool?flat
bool?normalize

Returns

TypeDescription
Task<DeserializedHttpResponse<PageContent>>

GetFromSectionsForSectionsAsync(ServiceConnection, int, string)

public static Task<DeserializedHttpResponse<Sections>> GetFromSectionsForSectionsAsync(this ServiceConnection serviceConnection, int docid, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intdocid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<Sections>>

GetFromSelectListForSelectListInfoAsync(ServiceConnection, string, string)

public static Task<DeserializedHttpResponse<SelectListInfo>> GetFromSelectListForSelectListInfoAsync(this ServiceConnection serviceConnection, string id, string selectListId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringselectListId

Returns

TypeDescription
Task<DeserializedHttpResponse<SelectListInfo>>

GetFromSelectListForSelectListInfoAsync(ServiceConnection, CancellationToken, string, string)

public static Task<DeserializedHttpResponse<SelectListInfo>> GetFromSelectListForSelectListInfoAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string selectListId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
stringselectListId

Returns

TypeDescription
Task<DeserializedHttpResponse<SelectListInfo>>

GetFromSelectListValuesForSelectListValuesResultAsync(ServiceConnection, string, int?, int?, string, string)

public static Task<DeserializedHttpResponse<SelectListValuesResult>> GetFromSelectListValuesForSelectListValuesResultAsync(this ServiceConnection serviceConnection, string selectListId, int? start = null, int? count = null, string prefix = null, string returnType = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringselectListId
int?start
int?count
stringprefix
stringreturnType

Returns

TypeDescription
Task<DeserializedHttpResponse<SelectListValuesResult>>

GetFromSingleColumnSelectListValuesResultForSingleColumnSelectListValuesAsync(ServiceConnection, string, int?, int?, string, string)

public static Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetFromSingleColumnSelectListValuesResultForSingleColumnSelectListValuesAsync(this ServiceConnection serviceConnection, string selectListId, int? start = null, int? count = null, string prefix = null, string returnType = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringselectListId
int?start
int?count
stringprefix
stringreturnType

Returns

TypeDescription
Task<DeserializedHttpResponse<SingleColumnSelectListValues>>

GetFromTasksCountForWorkflowTasksCountAsync(ServiceConnection, string)

public static Task<DeserializedHttpResponse<WorkflowTasksCount>> GetFromTasksCountForWorkflowTasksCountAsync(this ServiceConnection serviceConnection, string id)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasksCount>>

GetFromTasksCountForWorkflowTasksCountAsync(ServiceConnection, CancellationToken, string)

public static Task<DeserializedHttpResponse<WorkflowTasksCount>> GetFromTasksCountForWorkflowTasksCountAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasksCount>>

GetFromTasksForWorkflowTasksAsync(ServiceConnection, string, string[], int?, int?, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTasks>> GetFromTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, string id, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
string[]sortOrder
int?start
int?count
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasks>>

GetFromTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, string, string[], int?, int?, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTasks>> GetFromTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
string[]sortOrder
int?start
int?count
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasks>>

GetFromTextshotPreviewForStringAsync(ServiceConnection, int, string, string)

public static Task<DeserializedHttpResponse<string>> GetFromTextshotPreviewForStringAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, string fullTextQuery)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
stringfullTextQuery

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

GetFromTextshotPreviewForStringAsync(ServiceConnection, int, string, string, bool)

public static Task<DeserializedHttpResponse<string>> GetFromTextshotPreviewForStringAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, string fullTextQuery, bool addWildcards)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
stringfullTextQuery
booladdWildcards

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

GetFromTrashBinForTrashBinAsync(ServiceConnection)

public static Task<DeserializedHttpResponse<TrashBin>> GetFromTrashBinForTrashBinAsync(this ServiceConnection serviceConnection)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection

Returns

TypeDescription
Task<DeserializedHttpResponse<TrashBin>>

GetFromTrashedDocumentsForTrashBinDocumentsTableResultAsync(ServiceConnection, string, string[], int?, int?, bool?)

public static Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetFromTrashedDocumentsForTrashBinDocumentsTableResultAsync(this ServiceConnection serviceConnection, string q = null, string[] sortOrder = null, int? start = null, int? count = null, bool? calculateTotalCount = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringq
string[]sortOrder
int?start
int?count
bool?calculateTotalCount

Returns

TypeDescription
Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>>

GetFromUsersForUserByExternalIdAsync(ServiceConnection, string, string)

public static Task<DeserializedHttpResponse<User>> GetFromUsersForUserByExternalIdAsync(this ServiceConnection serviceConnection, string userExternalId, string externalProvider = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringuserExternalId
stringexternalProvider

Returns

TypeDescription
Task<DeserializedHttpResponse<User>>

GetFromUsersForUserByIdAsync(ServiceConnection, string)

public static Task<DeserializedHttpResponse<User>> GetFromUsersForUserByIdAsync(this ServiceConnection serviceConnection, string userId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringuserId

Returns

TypeDescription
Task<DeserializedHttpResponse<User>>

GetFromUsersForUserRolesAsync(ServiceConnection, string, bool?, string, string)

public static Task<DeserializedHttpResponse<Roles>> GetFromUsersForUserRolesAsync(this ServiceConnection serviceConnection, string userId, bool? active = null, string type = null, string name = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringuserId
bool?active
stringtype
stringname

Returns

TypeDescription
Task<DeserializedHttpResponse<Roles>>

GetFromUsersForUsersByRoleAsync(ServiceConnection, string, bool?)

public static Task<DeserializedHttpResponse<Users>> GetFromUsersForUsersByRoleAsync(this ServiceConnection serviceConnection, string roleId, bool? includeGroupUsers = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringroleId
bool?includeGroupUsers

Returns

TypeDescription
Task<DeserializedHttpResponse<Users>>

GetFromWorkflowDecisionsForDecisionAsync(ServiceConnection, string, string, string, int, bool?, bool?)

public static Task<DeserializedHttpResponse<Decision>> GetFromWorkflowDecisionsForDecisionAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, int decisionId, bool? ignoreErrors = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringinstanceId
stringtaskId
intdecisionId
bool?ignoreErrors
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Decision>>

GetFromWorkflowDecisionsForDecisionAsync(ServiceConnection, CancellationToken, string, string, string, int, bool?, bool?)

public static Task<DeserializedHttpResponse<Decision>> GetFromWorkflowDecisionsForDecisionAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, int decisionId, bool? ignoreErrors = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringinstanceId
stringtaskId
intdecisionId
bool?ignoreErrors
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Decision>>

GetFromWorkflowForWorkflowAsync(ServiceConnection, string, bool?)

public static Task<DeserializedHttpResponse<Workflow>> GetFromWorkflowForWorkflowAsync(this ServiceConnection serviceConnection, string id, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Workflow>>

GetFromWorkflowForWorkflowAsync(ServiceConnection, CancellationToken, string, bool?)

public static Task<DeserializedHttpResponse<Workflow>> GetFromWorkflowForWorkflowAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Workflow>>

GetFromWorkflowInstanceForInstanceAsync(ServiceConnection, string, string)

public static Task<DeserializedHttpResponse<Instance>> GetFromWorkflowInstanceForInstanceAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringinstanceId

Returns

TypeDescription
Task<DeserializedHttpResponse<Instance>>

GetFromWorkflowInstanceForInstanceAsync(ServiceConnection, CancellationToken, string, string)

public static Task<DeserializedHttpResponse<Instance>> GetFromWorkflowInstanceForInstanceAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringinstanceId

Returns

TypeDescription
Task<DeserializedHttpResponse<Instance>>

GetFromWorkflowRequestTaskForRequestTaskAsync(ServiceConnection, string, string, bool?)

public static Task<DeserializedHttpResponse<RequestTask>> GetFromWorkflowRequestTaskForRequestTaskAsync(this ServiceConnection serviceConnection, string workflowId, string taskId, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringtaskId
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<RequestTask>>

GetFromWorkflowRequestTaskForRequestTaskAsync(ServiceConnection, CancellationToken, string, string, bool?)

public static Task<DeserializedHttpResponse<RequestTask>> GetFromWorkflowRequestTaskForRequestTaskAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string taskId, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringtaskId
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<RequestTask>>

GetFromWorkflowTaskForWorkflowTaskAsync(ServiceConnection, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTask>> GetFromWorkflowTaskForWorkflowTaskAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, bool? loadColumnValues = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringinstanceId
stringtaskId
bool?loadColumnValues
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTask>>

GetFromWorkflowTaskForWorkflowTaskAsync(ServiceConnection, CancellationToken, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTask>> GetFromWorkflowTaskForWorkflowTaskAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, bool? loadColumnValues = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringinstanceId
stringtaskId
bool?loadColumnValues
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTask>>

GetFromWorkflowsForWorkflowsAsync(ServiceConnection, bool?)

public static Task<DeserializedHttpResponse<Workflows>> GetFromWorkflowsForWorkflowsAsync(this ServiceConnection serviceConnection, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Workflows>>

GetFromWorkflowsForWorkflowsAsync(ServiceConnection, CancellationToken, bool?)

public static Task<DeserializedHttpResponse<Workflows>> GetFromWorkflowsForWorkflowsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<Workflows>>

GetGroupFromGroupAsync(ServiceConnection, string)

public static Task<DeserializedHttpResponse<Group>> GetGroupFromGroupAsync(this ServiceConnection serviceConnection, string groupId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringgroupId

Returns

TypeDescription
Task<DeserializedHttpResponse<Group>>

GetGroupFromGroupAsync(ServiceConnection, CancellationToken, string)

public static Task<DeserializedHttpResponse<Group>> GetGroupFromGroupAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string groupId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringgroupId

Returns

TypeDescription
Task<DeserializedHttpResponse<Group>>

GetGroupsFromGroupsQueryParamsAsync(ServiceConnection, bool?, string)

public static Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsQueryParamsAsync(this ServiceConnection serviceConnection, bool? active = null, string name = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
bool?active
stringname

Returns

TypeDescription
Task<DeserializedHttpResponse<Groups>>

GetRolesFromRolesQueryParamsAsync(ServiceConnection, bool?, string, string)

public static Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesQueryParamsAsync(this ServiceConnection serviceConnection, bool? active = null, string name = null, string type = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
bool?active
stringname
stringtype

Returns

TypeDescription
Task<DeserializedHttpResponse<Roles>>

GetUserGroupsFromUserGroupsQueryParamsAsync(ServiceConnection, string, bool?, string)

public static Task<DeserializedHttpResponse<Groups>> GetUserGroupsFromUserGroupsQueryParamsAsync(this ServiceConnection serviceConnection, string userId = null, bool? active = null, string name = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringuserId
bool?active
stringname

Returns

TypeDescription
Task<DeserializedHttpResponse<Groups>>

GetUsersFromUsersQueryParamsAsync(ServiceConnection, bool?, string)

public static Task<DeserializedHttpResponse<Users>> GetUsersFromUsersQueryParamsAsync(this ServiceConnection serviceConnection, bool? active = null, string name = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
bool?active
stringname

Returns

TypeDescription
Task<DeserializedHttpResponse<Users>>

PostFilterUsersFromUsersQueryAsync(ServiceConnection, UsersQuery)

public static Task<DeserializedHttpResponse<Users>> PostFilterUsersFromUsersQueryAsync(this ServiceConnection serviceConnection, UsersQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
UsersQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<Users>>

PostFromSectionTextshotForStringAsync(ServiceConnection, string, string)

public static Task<DeserializedHttpResponse<string>> PostFromSectionTextshotForStringAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostGroupFromCreateGroupAsync(ServiceConnection, Group)

public static Task<DeserializedHttpResponse<Group>> PostGroupFromCreateGroupAsync(this ServiceConnection serviceConnection, Group data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
Groupdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Group>>

PostGroupFromCreateGroupAsync(ServiceConnection, CancellationToken, Group)

public static Task<DeserializedHttpResponse<Group>> PostGroupFromCreateGroupAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, Group data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
Groupdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Group>>

PostGroupsFromGroupsQueryAsync(ServiceConnection, GroupsQuery)

public static Task<DeserializedHttpResponse<Groups>> PostGroupsFromGroupsQueryAsync(this ServiceConnection serviceConnection, GroupsQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
GroupsQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<Groups>>

PostRolesFromRolesQueryAsync(ServiceConnection, RolesQuery)

public static Task<DeserializedHttpResponse<Roles>> PostRolesFromRolesQueryAsync(this ServiceConnection serviceConnection, RolesQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
RolesQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<Roles>>

PostToAnnotationForAnnotationAsync(ServiceConnection, string, string, int, Annotation)

public static Task<DeserializedHttpResponse<Annotation>> PostToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, Annotation data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage
Annotationdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PostToAnnotationForAnnotationAsync(ServiceConnection, string, string, int, AnnotationsPlacement)

public static Task<DeserializedHttpResponse<Annotation>> PostToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, AnnotationsPlacement data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage
AnnotationsPlacementdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PostToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int, Annotation)

public static Task<DeserializedHttpResponse<Annotation>> PostToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page, Annotation data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
stringfileCabinetId
intpage
Annotationdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PostToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int, AnnotationsPlacement)

public static Task<DeserializedHttpResponse<Annotation>> PostToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page, AnnotationsPlacement data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
stringfileCabinetId
intpage
AnnotationsPlacementdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PostToArchiveDocumentForStreamAsync(ServiceConnection, string, int, ExportSettings)

public static Task<DeserializedHttpResponse<Stream>> PostToArchiveDocumentForStreamAsync(this ServiceConnection serviceConnection, string fileCabinetId, int id, ExportSettings data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
intid
ExportSettingsdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Stream>>

PostToAreValuesInSelectListForAreValuesInSelectListsResultAsync(ServiceConnection, string, SelectListValuesToCheck)

public static Task<DeserializedHttpResponse<AreValuesInSelectListsResult>> PostToAreValuesInSelectListForAreValuesInSelectListsResultAsync(this ServiceConnection serviceConnection, string selectListId, SelectListValuesToCheck data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringselectListId
SelectListValuesToCheckdata

Returns

TypeDescription
Task<DeserializedHttpResponse<AreValuesInSelectListsResult>>

PostToBatchDeleteForBatchDeleteResultAsync(ServiceConnection, BatchDeleteDocumentsSource)

public static Task<DeserializedHttpResponse<BatchDeleteResult>> PostToBatchDeleteForBatchDeleteResultAsync(this ServiceConnection serviceConnection, BatchDeleteDocumentsSource data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
BatchDeleteDocumentsSourcedata

Returns

TypeDescription
Task<DeserializedHttpResponse<BatchDeleteResult>>

PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, string, string, BatchUpdateProcess, string[], string[])

public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string id, BatchUpdateProcess data, string[] fields = null, string[] sortOrder = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringid
BatchUpdateProcessdata
string[]fields
string[]sortOrder

Returns

TypeDescription
Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>>

PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, CancellationToken, string, string, BatchUpdateProcess, string[], string[])

public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string id, BatchUpdateProcess data, string[] fields = null, string[] sortOrder = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
stringid
BatchUpdateProcessdata
string[]fields
string[]sortOrder

Returns

TypeDescription
Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>>

PostToBatchQueryUpdateFieldsOperationForBatchUpdateIndexFieldsResultAsync(ServiceConnection, string, BatchUpdateProcessData, string[], string[], string, int?)

public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchQueryUpdateFieldsOperationForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, BatchUpdateProcessData data, string[] fields = null, string[] sortOrder = null, string q = null, int? start = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
BatchUpdateProcessDatadata
string[]fields
string[]sortOrder
stringq
int?start

Returns

TypeDescription
Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>>

PostToBatchRestoreForBatchRestoreResultAsync(ServiceConnection, BatchRestoreDocumentsSource)

public static Task<DeserializedHttpResponse<BatchRestoreResult>> PostToBatchRestoreForBatchRestoreResultAsync(this ServiceConnection serviceConnection, BatchRestoreDocumentsSource data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
BatchRestoreDocumentsSourcedata

Returns

TypeDescription
Task<DeserializedHttpResponse<BatchRestoreResult>>

PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, string, BatchAppendKeywordValues)

public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, BatchAppendKeywordValues data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
BatchAppendKeywordValuesdata

Returns

TypeDescription
Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>>

PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, string, BatchUpdateProcess)

public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, BatchUpdateProcess data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
BatchUpdateProcessdata

Returns

TypeDescription
Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>>

PostToCheckinForDocumentAsync(ServiceConnection, int, string, MultipartFormDataContent)

public static Task<DeserializedHttpResponse<Document>> PostToCheckinForDocumentAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, MultipartFormDataContent data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
MultipartFormDataContentdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToCheckinForDocumentAsync(ServiceConnection, CancellationToken, int, string, MultipartFormDataContent)

public static Task<DeserializedHttpResponse<Document>> PostToCheckinForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, MultipartFormDataContent data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
MultipartFormDataContentdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToCheckoutDocumentForCheckOutResultAsync(ServiceConnection, int, string, CheckOutToFileSystemInfo)

public static Task<DeserializedHttpResponse<CheckOutResult>> PostToCheckoutDocumentForCheckOutResultAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, CheckOutToFileSystemInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
CheckOutToFileSystemInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<CheckOutResult>>

PostToCheckoutDocumentForCheckOutResultAsync(ServiceConnection, CancellationToken, int, string, CheckOutToFileSystemInfo)

public static Task<DeserializedHttpResponse<CheckOutResult>> PostToCheckoutDocumentForCheckOutResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, CheckOutToFileSystemInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
CheckOutToFileSystemInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<CheckOutResult>>

PostToCheckoutForStreamAsync(ServiceConnection, int, string, CheckOutToFileSystemInfo)

public static Task<DeserializedHttpResponse<Stream>> PostToCheckoutForStreamAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, CheckOutToFileSystemInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
CheckOutToFileSystemInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<Stream>>

PostToCheckoutForStreamAsync(ServiceConnection, CancellationToken, int, string, CheckOutToFileSystemInfo)

public static Task<DeserializedHttpResponse<Stream>> PostToCheckoutForStreamAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, CheckOutToFileSystemInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
CheckOutToFileSystemInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<Stream>>

PostToClippedDocumentsForDocumentAsync(ServiceConnection, int, string, IntegerList, ContentMergeOperation?)

public static Task<DeserializedHttpResponse<Document>> PostToClippedDocumentsForDocumentAsync(this ServiceConnection serviceConnection, int docId, string fileCabinetId, IntegerList data, ContentMergeOperation? operation = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intdocId
stringfileCabinetId
IntegerListdata
ContentMergeOperation?operation

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToClippedDocumentsForDocumentAsync(ServiceConnection, CancellationToken, int, string, IntegerList, ContentMergeOperation?)

public static Task<DeserializedHttpResponse<Document>> PostToClippedDocumentsForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int docId, string fileCabinetId, IntegerList data, ContentMergeOperation? operation = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intdocId
stringfileCabinetId
IntegerListdata
ContentMergeOperation?operation

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToContentDivideForDocumentsQueryResultAsync(ServiceConnection, string, int, ContentDivideOperationInfo)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToContentDivideForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, int docId, ContentDivideOperationInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
intdocId
ContentDivideOperationInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

PostToContentMergeForDocumentAsync(ServiceConnection, string, ContentMergeOperationInfo)

public static Task<DeserializedHttpResponse<Document>> PostToContentMergeForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, ContentMergeOperationInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
ContentMergeOperationInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToControllerWorkflowConfirmForStringAsync(ServiceConnection, string, string, string, int, ConfirmedData)

public static Task<DeserializedHttpResponse<string>> PostToControllerWorkflowConfirmForStringAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, int decisionId, ConfirmedData data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringinstanceId
stringtaskId
intdecisionId
ConfirmedDatadata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToControllerWorkflowConfirmForStringAsync(ServiceConnection, CancellationToken, string, string, string, int, ConfirmedData)

public static Task<DeserializedHttpResponse<string>> PostToControllerWorkflowConfirmForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, int decisionId, ConfirmedData data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringinstanceId
stringtaskId
intdecisionId
ConfirmedDatadata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, string, TasksQuery, string[], int?, int?, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTasks>> PostToControllerWorkflowTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, string id, TasksQuery data, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
TasksQuerydata
string[]sortOrder
int?start
int?count
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasks>>

PostToControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, string, TasksQuery, string[], int?, int?, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTasks>> PostToControllerWorkflowTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, TasksQuery data, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
TasksQuerydata
string[]sortOrder
int?start
int?count
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasks>>

PostToCreatePermanentUrlForStringAsync(ServiceConnection, FormUrlEncodedContent, bool?)

public static Task<DeserializedHttpResponse<string>> PostToCreatePermanentUrlForStringAsync(this ServiceConnection serviceConnection, FormUrlEncodedContent data, bool? clientSideChecksum = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
FormUrlEncodedContentdata
bool?clientSideChecksum

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToCreatePermanentUrlForStringAsync(ServiceConnection, CancellationToken, FormUrlEncodedContent, bool?)

public static Task<DeserializedHttpResponse<string>> PostToCreatePermanentUrlForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, FormUrlEncodedContent data, bool? clientSideChecksum = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
FormUrlEncodedContentdata
bool?clientSideChecksum

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToCreateUserDefinedSearchForDialogAsync(ServiceConnection, string, string, UserDefinedSearchInfo)

public static Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchForDialogAsync(this ServiceConnection serviceConnection, string fileCabinetId, string id, UserDefinedSearchInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringid
UserDefinedSearchInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<Dialog>>

PostToCreateUserDefinedSearchForDialogAsync(ServiceConnection, CancellationToken, string, string, UserDefinedSearchInfo)

public static Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchForDialogAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string id, UserDefinedSearchInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
stringid
UserDefinedSearchInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<Dialog>>

PostToDialogExpressionForDocumentsQueryResultAsync(ServiceConnection, string, string, DialogExpression, string[], string[], int?, int?)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToDialogExpressionForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string dialogId, DialogExpression data, string[] fields = null, string[] sortOrder = null, int? start = null, int? count = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringdialogId
DialogExpressiondata
string[]fields
string[]sortOrder
int?start
int?count

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

PostToDialogExpressionForDocumentsQueryResultAsync(ServiceConnection, CancellationToken, string, string, DialogExpression, string[], string[], int?, int?)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToDialogExpressionForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string dialogId, DialogExpression data, string[] fields = null, string[] sortOrder = null, int? start = null, int? count = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
stringdialogId
DialogExpressiondata
string[]fields
string[]sortOrder
int?start
int?count

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

PostToDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, int, string, DocumentAnnotationsPlacement)

public static Task<DeserializedHttpResponse<DocumentAnnotations>> PostToDocumentAnnotationsForDocumentAnnotationsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, DocumentAnnotationsPlacement data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
DocumentAnnotationsPlacementdata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentAnnotations>>

PostToDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, CancellationToken, int, string, DocumentAnnotationsPlacement)

public static Task<DeserializedHttpResponse<DocumentAnnotations>> PostToDocumentAnnotationsForDocumentAnnotationsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, DocumentAnnotationsPlacement data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
DocumentAnnotationsPlacementdata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentAnnotations>>

PostToDocumentAppendFilesForDocumentAsync(ServiceConnection, int, string, MultipartFormDataContent)

public static Task<DeserializedHttpResponse<Document>> PostToDocumentAppendFilesForDocumentAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, MultipartFormDataContent data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
MultipartFormDataContentdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToDocumentAppendFilesForDocumentAsync(ServiceConnection, CancellationToken, int, string, MultipartFormDataContent)

public static Task<DeserializedHttpResponse<Document>> PostToDocumentAppendFilesForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, MultipartFormDataContent data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
MultipartFormDataContentdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(ServiceConnection, int, string, DocumentApplicationProperties)

public static Task<DeserializedHttpResponse<DocumentApplicationProperties>> PostToDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, DocumentApplicationProperties data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
DocumentApplicationPropertiesdata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentApplicationProperties>>

PostToDocumentDeleteVersionHistoryForStringAsync(ServiceConnection, int, string)

Deletes the version history of the document.

[Wolf]
public static Task<DeserializedHttpResponse<string>> PostToDocumentDeleteVersionHistoryForStringAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection

The service connection

intid

The id of the document

stringfileCabinetId

The id of the file cabinet

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string, DocumentIndexFields)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, DocumentIndexFields data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
DocumentIndexFieldsdata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string, UpdateIndexFieldsInfo)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, UpdateIndexFieldsInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
UpdateIndexFieldsInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string, DocumentIndexFields)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, DocumentIndexFields data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
DocumentIndexFieldsdata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string, UpdateIndexFieldsInfo)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, UpdateIndexFieldsInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
UpdateIndexFieldsInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

PostToDocumentRightsForRightsAsync(ServiceConnection, int, string, Rights)

public static Task<DeserializedHttpResponse<Rights>> PostToDocumentRightsForRightsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, Rights data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
Rightsdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Rights>>

PostToDocumentRightsForRightsAsync(ServiceConnection, CancellationToken, int, string, Rights)

public static Task<DeserializedHttpResponse<Rights>> PostToDocumentRightsForRightsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, Rights data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
Rightsdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Rights>>

PostToDocumentlessTriggerForStringAsync(ServiceConnection, string, DocumentlessTriggerData)

public static Task<DeserializedHttpResponse<string>> PostToDocumentlessTriggerForStringAsync(this ServiceConnection serviceConnection, string workflowId, DocumentlessTriggerData data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
DocumentlessTriggerDatadata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToDocumentlessTriggerForStringAsync(ServiceConnection, CancellationToken, string, DocumentlessTriggerData)

public static Task<DeserializedHttpResponse<string>> PostToDocumentlessTriggerForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, DocumentlessTriggerData data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
DocumentlessTriggerDatadata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToExportForStreamAsync(ServiceConnection, string, ExportSettings, string, string[], string[])

public static Task<DeserializedHttpResponse<Stream>> PostToExportForStreamAsync(this ServiceConnection serviceConnection, string fileCabinetId, ExportSettings data, string q = null, string[] fields = null, string[] sortOrder = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
ExportSettingsdata
stringq
string[]fields
string[]sortOrder

Returns

TypeDescription
Task<DeserializedHttpResponse<Stream>>

PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(ServiceConnection, string, SelectListExpression)

public static Task<DeserializedHttpResponse<FieldValueStatisticsResult>> PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, SelectListExpression data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
SelectListExpressiondata

Returns

TypeDescription
Task<DeserializedHttpResponse<FieldValueStatisticsResult>>

PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(ServiceConnection, CancellationToken, string, SelectListExpression)

public static Task<DeserializedHttpResponse<FieldValueStatisticsResult>> PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, SelectListExpression data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
SelectListExpressiondata

Returns

TypeDescription
Task<DeserializedHttpResponse<FieldValueStatisticsResult>>

PostToFunctionExpressionForDocumentsQueryTableResultAsync(ServiceConnection, string, FunctionExpressionQuery, string[], string[], int?, int?)

public static Task<DeserializedHttpResponse<DocumentsQueryTableResult>> PostToFunctionExpressionForDocumentsQueryTableResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, FunctionExpressionQuery data, string[] fields = null, string[] sortOrder = null, int? start = null, int? count = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
FunctionExpressionQuerydata
string[]fields
string[]sortOrder
int?start
int?count

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryTableResult>>

PostToImportDocumentForImportResultAsync(ServiceConnection, string, Stream)

public static Task<DeserializedHttpResponse<ImportResult>> PostToImportDocumentForImportResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, Stream data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
Streamdata

Returns

TypeDescription
Task<DeserializedHttpResponse<ImportResult>>

PostToImportDocumentForImportResultAsync(ServiceConnection, CancellationToken, string, Stream)

public static Task<DeserializedHttpResponse<ImportResult>> PostToImportDocumentForImportResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, Stream data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
Streamdata

Returns

TypeDescription
Task<DeserializedHttpResponse<ImportResult>>

PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(ServiceConnection, string, MultiColSelectListValuesQuery)

public static Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(this ServiceConnection serviceConnection, string selectListId, MultiColSelectListValuesQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringselectListId
MultiColSelectListValuesQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<MultiColSelectListValuesResult>>

PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(ServiceConnection, CancellationToken, string, MultiColSelectListValuesQuery)

public static Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string selectListId, MultiColSelectListValuesQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringselectListId
MultiColSelectListValuesQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<MultiColSelectListValuesResult>>

PostToMultiColumnSelectListValuesForSelectListValuesResultAsync(ServiceConnection, string, MultiColumnSelectListValuesQuery)

public static Task<DeserializedHttpResponse<SelectListValuesResult>> PostToMultiColumnSelectListValuesForSelectListValuesResultAsync(this ServiceConnection serviceConnection, string selectListId, MultiColumnSelectListValuesQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringselectListId
MultiColumnSelectListValuesQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<SelectListValuesResult>>

PostToQueryDocumentsForDocumentsQueryResultAsync(ServiceConnection, string, DocumentLinkExpressionQuery, string, string[], string[], int?, int?, string, string, string, string, bool?, bool?, bool?)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToQueryDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, DocumentLinkExpressionQuery data, string q = null, string[] fields = null, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string additionalCabinets = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? includeSuggestions = null, bool? calculateTotalCount = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
DocumentLinkExpressionQuerydata
stringq
string[]fields
string[]sortOrder
int?start
int?count
stringformat
stringadditionalCabinets
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?includeSuggestions
bool?calculateTotalCount

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

PostToQueryDocumentsForDocumentsQueryResultAsync(ServiceConnection, string, ResultListQuery, string, string[], string[], int?, int?, string, string, string, string, bool?, bool?, bool?)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToQueryDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, ResultListQuery data, string q = null, string[] fields = null, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string additionalCabinets = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? includeSuggestions = null, bool? calculateTotalCount = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
ResultListQuerydata
stringq
string[]fields
string[]sortOrder
int?start
int?count
stringformat
stringadditionalCabinets
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?includeSuggestions
bool?calculateTotalCount

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

PostToQueryTrashedDocumentsForTrashBinDocumentsTableResultAsync(ServiceConnection, TrashBinQuery)

public static Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> PostToQueryTrashedDocumentsForTrashBinDocumentsTableResultAsync(this ServiceConnection serviceConnection, TrashBinQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
TrashBinQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>>

PostToRequestTasksForRequestTasksAsync(ServiceConnection, TasksQuery, int?, int?, string, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<RequestTasks>> PostToRequestTasksForRequestTasksAsync(this ServiceConnection serviceConnection, TasksQuery data, int? start = null, int? count = null, string sortOrder = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
TasksQuerydata
int?start
int?count
stringsortOrder
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<RequestTasks>>

PostToRequestTasksForRequestTasksAsync(ServiceConnection, CancellationToken, TasksQuery, int?, int?, string, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<RequestTasks>> PostToRequestTasksForRequestTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, TasksQuery data, int? start = null, int? count = null, string sortOrder = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
TasksQuerydata
int?start
int?count
stringsortOrder
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<RequestTasks>>

PostToRetrieveSequenceElementForSequenceResultAsync(ServiceConnection, string, SequenceRequest)

public static Task<DeserializedHttpResponse<SequenceResult>> PostToRetrieveSequenceElementForSequenceResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, SequenceRequest data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
SequenceRequestdata

Returns

TypeDescription
Task<DeserializedHttpResponse<SequenceResult>>

PostToRetrieveSequenceElementForSequenceResultAsync(ServiceConnection, CancellationToken, string, SequenceRequest)

public static Task<DeserializedHttpResponse<SequenceResult>> PostToRetrieveSequenceElementForSequenceResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, SequenceRequest data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
SequenceRequestdata

Returns

TypeDescription
Task<DeserializedHttpResponse<SequenceResult>>

PostToSectionPagesBlockResultForPagesAsync(ServiceConnection, string, string, PagesBlockQuery)

public static Task<DeserializedHttpResponse<Pages>> PostToSectionPagesBlockResultForPagesAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, PagesBlockQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
PagesBlockQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<Pages>>

PostToSectionStampBestPositionForDWPointAsync(ServiceConnection, string, string, int, StampFormFieldValues)

public static Task<DeserializedHttpResponse<DWPoint>> PostToSectionStampBestPositionForDWPointAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, StampFormFieldValues data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage
StampFormFieldValuesdata

Returns

TypeDescription
Task<DeserializedHttpResponse<DWPoint>>

PostToSectionStampForAnnotationAsync(ServiceConnection, string, string, int, StampPlacement)

public static Task<DeserializedHttpResponse<Annotation>> PostToSectionStampForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, StampPlacement data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage
StampPlacementdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PostToSelectListExpressionForSelectListResultAsync(ServiceConnection, string, string, string, string, SelectListExpression)

public static Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListExpressionForSelectListResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string dialogId, string fieldName, string parentFieldName, SelectListExpression data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringdialogId
stringfieldName
stringparentFieldName
SelectListExpressiondata

Returns

TypeDescription
Task<DeserializedHttpResponse<SelectListResult>>

PostToSelectListExpressionForSelectListResultAsync(ServiceConnection, CancellationToken, string, string, string, string, SelectListExpression)

public static Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListExpressionForSelectListResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string dialogId, string fieldName, string parentFieldName, SelectListExpression data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
stringdialogId
stringfieldName
stringparentFieldName
SelectListExpressiondata

Returns

TypeDescription
Task<DeserializedHttpResponse<SelectListResult>>

PostToSelectListValuesForSingleColumnSelectListValuesAsync(ServiceConnection, string, SelectListValuesQuery)

public static Task<DeserializedHttpResponse<SingleColumnSelectListValues>> PostToSelectListValuesForSingleColumnSelectListValuesAsync(this ServiceConnection serviceConnection, string selectListId, SelectListValuesQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringselectListId
SelectListValuesQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<SingleColumnSelectListValues>>

PostToTasksForWorkflowTasksAsync(ServiceConnection, string, TasksQuery, string[], int?, int?, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTasks>> PostToTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, string id, TasksQuery data, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
TasksQuerydata
string[]sortOrder
int?start
int?count
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasks>>

PostToTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, string, TasksQuery, string[], int?, int?, string, string, string, bool?, bool?)

public static Task<DeserializedHttpResponse<WorkflowTasks>> PostToTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, TasksQuery data, string[] sortOrder = null, int? start = null, int? count = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = null, bool? removeLinks = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
TasksQuerydata
string[]sortOrder
int?start
int?count
stringformat
stringencodingName
stringcsvDelimiter
bool?csvIsUtc
bool?removeLinks

Returns

TypeDescription
Task<DeserializedHttpResponse<WorkflowTasks>>

PostToTransferForDocumentsQueryResultAsync(ServiceConnection, string, string, DocumentsTransferInfo)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToTransferForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string storeDialogId, DocumentsTransferInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringstoreDialogId
DocumentsTransferInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

PostToTransferForDocumentsQueryResultAsync(ServiceConnection, string, string, FileCabinetTransferInfo)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToTransferForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string storeDialogId, FileCabinetTransferInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
stringstoreDialogId
FileCabinetTransferInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

PostToUploadDocumentForDocumentAsync(ServiceConnection, string, Document, bool?, bool?, string, string, bool?)

public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, Document data, bool? processTextshot = null, bool? imageProcessing = null, string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
Documentdata
bool?processTextshot
bool?imageProcessing
stringredirect
stringstoreDialogId
bool?checkFileNameForCheckinInfo

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToUploadDocumentForDocumentAsync(ServiceConnection, string, InputDocument, bool?, bool?, string, string, bool?)

public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, InputDocument data, bool? processTextshot = null, bool? imageProcessing = null, string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
InputDocumentdata
bool?processTextshot
bool?imageProcessing
stringredirect
stringstoreDialogId
bool?checkFileNameForCheckinInfo

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToUploadDocumentForDocumentAsync(ServiceConnection, string, Stream, bool?, bool?, string, string, bool?)

public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, Stream data, bool? processTextshot = null, bool? imageProcessing = null, string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
Streamdata
bool?processTextshot
bool?imageProcessing
stringredirect
stringstoreDialogId
bool?checkFileNameForCheckinInfo

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToUploadDocumentForDocumentAsync(ServiceConnection, CancellationToken, string, Document, bool?, bool?, string, string, bool?)

public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, Document data, bool? processTextshot = null, bool? imageProcessing = null, string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
Documentdata
bool?processTextshot
bool?imageProcessing
stringredirect
stringstoreDialogId
bool?checkFileNameForCheckinInfo

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToUploadDocumentForDocumentAsync(ServiceConnection, CancellationToken, string, Stream, bool?, bool?, string, string, bool?)

public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, Stream data, bool? processTextshot = null, bool? imageProcessing = null, string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
Streamdata
bool?processTextshot
bool?imageProcessing
stringredirect
stringstoreDialogId
bool?checkFileNameForCheckinInfo

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PostToUsersForUserRolesAsync(ServiceConnection, UserRolesQuery, string, bool?, string, string)

public static Task<DeserializedHttpResponse<Roles>> PostToUsersForUserRolesAsync(this ServiceConnection serviceConnection, UserRolesQuery data, string userId, bool? active = null, string type = null, string name = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
UserRolesQuerydata
stringuserId
bool?active
stringtype
stringname

Returns

TypeDescription
Task<DeserializedHttpResponse<Roles>>

PostToUsersForUsersByRoleAsync(ServiceConnection, UsersByRole, string, bool?)

public static Task<DeserializedHttpResponse<Users>> PostToUsersForUsersByRoleAsync(this ServiceConnection serviceConnection, UsersByRole data, string roleId, bool? includeGroupUsers = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
UsersByRoledata
stringroleId
bool?includeGroupUsers

Returns

TypeDescription
Task<DeserializedHttpResponse<Users>>

PostToValidateUserForStringAsync(ServiceConnection, string, UserValidation)

public static Task<DeserializedHttpResponse<string>> PostToValidateUserForStringAsync(this ServiceConnection serviceConnection, string id, UserValidation data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
UserValidationdata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToValidateUserForStringAsync(ServiceConnection, CancellationToken, string, UserValidation)

public static Task<DeserializedHttpResponse<string>> PostToValidateUserForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, UserValidation data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
UserValidationdata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToWorkflowConfirmForStringAsync(ServiceConnection, string, string, string, int, ConfirmedData)

public static Task<DeserializedHttpResponse<string>> PostToWorkflowConfirmForStringAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, int decisionId, ConfirmedData data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringworkflowId
stringinstanceId
stringtaskId
intdecisionId
ConfirmedDatadata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostToWorkflowConfirmForStringAsync(ServiceConnection, CancellationToken, string, string, string, int, ConfirmedData)

public static Task<DeserializedHttpResponse<string>> PostToWorkflowConfirmForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, int decisionId, ConfirmedData data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringworkflowId
stringinstanceId
stringtaskId
intdecisionId
ConfirmedDatadata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PostUserGroupsFromUserGroupsQueryAsync(ServiceConnection, UserGroupsQuery)

public static Task<DeserializedHttpResponse<Groups>> PostUserGroupsFromUserGroupsQueryAsync(this ServiceConnection serviceConnection, UserGroupsQuery data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
UserGroupsQuerydata

Returns

TypeDescription
Task<DeserializedHttpResponse<Groups>>

PutFromSectionTextshotForStringAsync(ServiceConnection, string, string)

public static Task<DeserializedHttpResponse<string>> PutFromSectionTextshotForStringAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

PutToAnnotationForAnnotationAsync(ServiceConnection, string, string, int, Annotation)

public static Task<DeserializedHttpResponse<Annotation>> PutToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, Annotation data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage
Annotationdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PutToAnnotationForAnnotationAsync(ServiceConnection, string, string, int, AnnotationsPlacement)

public static Task<DeserializedHttpResponse<Annotation>> PutToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, AnnotationsPlacement data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringid
stringfileCabinetId
intpage
AnnotationsPlacementdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PutToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int, Annotation)

public static Task<DeserializedHttpResponse<Annotation>> PutToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page, Annotation data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
stringfileCabinetId
intpage
Annotationdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PutToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int, AnnotationsPlacement)

public static Task<DeserializedHttpResponse<Annotation>> PutToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page, AnnotationsPlacement data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringid
stringfileCabinetId
intpage
AnnotationsPlacementdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Annotation>>

PutToClippedDocumentsForDocumentAsync(ServiceConnection, int, string, IntegerList, ContentMergeOperation?)

public static Task<DeserializedHttpResponse<Document>> PutToClippedDocumentsForDocumentAsync(this ServiceConnection serviceConnection, int docId, string fileCabinetId, IntegerList data, ContentMergeOperation? operation = null)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intdocId
stringfileCabinetId
IntegerListdata
ContentMergeOperation?operation

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PutToContentDivideForDocumentsQueryResultAsync(ServiceConnection, string, int, ContentDivideOperationInfo)

public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PutToContentDivideForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, int docId, ContentDivideOperationInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
intdocId
ContentDivideOperationInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentsQueryResult>>

PutToContentMergeForDocumentAsync(ServiceConnection, string, ContentMergeOperationInfo)

public static Task<DeserializedHttpResponse<Document>> PutToContentMergeForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, ContentMergeOperationInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
ContentMergeOperationInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string, DocumentIndexFields)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, DocumentIndexFields data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
DocumentIndexFieldsdata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string, UpdateIndexFieldsInfo)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, UpdateIndexFieldsInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
UpdateIndexFieldsInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string, DocumentIndexFields)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, DocumentIndexFields data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
DocumentIndexFieldsdata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string, UpdateIndexFieldsInfo)

public static Task<DeserializedHttpResponse<DocumentIndexFields>> PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, UpdateIndexFieldsInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
UpdateIndexFieldsInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<DocumentIndexFields>>

PutToDocumentSectionsReorderForSectionsAsync(ServiceConnection, int, string, ReorderSectionsRequest)

public static Task<DeserializedHttpResponse<Sections>> PutToDocumentSectionsReorderForSectionsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, ReorderSectionsRequest data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
intid
stringfileCabinetId
ReorderSectionsRequestdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Sections>>

PutToDocumentSectionsReorderForSectionsAsync(ServiceConnection, CancellationToken, int, string, ReorderSectionsRequest)

public static Task<DeserializedHttpResponse<Sections>> PutToDocumentSectionsReorderForSectionsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, ReorderSectionsRequest data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
intid
stringfileCabinetId
ReorderSectionsRequestdata

Returns

TypeDescription
Task<DeserializedHttpResponse<Sections>>

PutToProcessDocumentActionForDocumentAsync(ServiceConnection, string, int, DocumentActionInfo)

public static Task<DeserializedHttpResponse<Document>> PutToProcessDocumentActionForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, int docId, DocumentActionInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringfileCabinetId
intdocId
DocumentActionInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PutToProcessDocumentActionForDocumentAsync(ServiceConnection, CancellationToken, string, int, DocumentActionInfo)

public static Task<DeserializedHttpResponse<Document>> PutToProcessDocumentActionForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, int docId, DocumentActionInfo data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
stringfileCabinetId
intdocId
DocumentActionInfodata

Returns

TypeDescription
Task<DeserializedHttpResponse<Document>>

PutToUpdateGroupForGroupAsync(ServiceConnection, Group)

public static Task<DeserializedHttpResponse<Group>> PutToUpdateGroupForGroupAsync(this ServiceConnection serviceConnection, Group group)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
Groupgroup

Returns

TypeDescription
Task<DeserializedHttpResponse<Group>>

PutToUpdateGroupForGroupAsync(ServiceConnection, CancellationToken, Group)

public static Task<DeserializedHttpResponse<Group>> PutToUpdateGroupForGroupAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, Group group)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
CancellationTokencancellationToken
Groupgroup

Returns

TypeDescription
Task<DeserializedHttpResponse<Group>>

PutToUsersByGroupForStringAsync(ServiceConnection, string, AssignmentOperation)

public static Task<DeserializedHttpResponse<string>> PutToUsersByGroupForStringAsync(this ServiceConnection serviceConnection, string groupId, AssignmentOperation data)

Parameters

TypeNameDescription
ServiceConnectionserviceConnection
stringgroupId
AssignmentOperationdata

Returns

TypeDescription
Task<DeserializedHttpResponse<string>>

ToRectangle(LineEntry)

Gets the bounding box from the specified entry.

public static AnnotationRectangle ToRectangle(this LineEntry entry)

Parameters

TypeNameDescription
LineEntryentry

The entry.

Returns

TypeDescription
AnnotationRectangle