Class SchemaExtensions
Inheritance
System.Object
SchemaExtensions
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: DocuWare.Platform.ServerClient.dll
public static class SchemaExtensions
Methods
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryTableResult>> CreateUserDefinedSearchOperation(this ServiceConnection serviceConnection, string fileCabinetId, FunctionExpressionQuery data, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
FunctionExpressionQuery |
data |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<string>> DeleteFromDocumentDeleteForStringAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<string>> DeleteFromDocumentDeleteForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<string>> DeleteFromWorkflowInstanceForStringAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<string>> DeleteFromWorkflowInstanceForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Annotation>> GetFromAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Annotation>> GetFromAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentAuditEventInformation>> GetFromAuditEventPropertiesForDocumentAuditEventInformationAsync(this ServiceConnection serviceConnection, string fileCabinetId, string eventId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.String |
eventId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentAuditEventInformation>> GetFromAuditEventPropertiesForDocumentAuditEventInformationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string eventId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.String |
eventId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<XElement>> GetFromClientSetupDataForXElementAsync(this ServiceConnection serviceConnection, string orgId, string baseAddress = null, string clientSetupVersion = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
orgId |
|
System.String |
baseAddress |
|
System.String |
clientSetupVersion |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<XElement>> GetFromClientSetupDataForXElementAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string orgId, string baseAddress = null, string clientSetupVersion = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
orgId |
|
System.String |
baseAddress |
|
System.String |
clientSetupVersion |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Decision>> GetFromControllerWorkflowDecisionsForDecisionAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, int decisionId, bool? ignoreErrors = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Int32 |
decisionId |
|
System.Nullable<System.Boolean> |
ignoreErrors |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Decision>> GetFromControllerWorkflowDecisionsForDecisionAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, int decisionId, bool? ignoreErrors = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Int32 |
decisionId |
|
System.Nullable<System.Boolean> |
ignoreErrors |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Workflow>> GetFromControllerWorkflowForWorkflowAsync(this ServiceConnection serviceConnection, string id, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Workflow>> GetFromControllerWorkflowForWorkflowAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Workflows>> GetFromControllerWorkflowsForWorkflowsAsync(this ServiceConnection serviceConnection, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Workflows>> GetFromControllerWorkflowsForWorkflowsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTask>> GetFromControllerWorkflowTaskForWorkflowTaskAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, bool? loadColumnValues = default(bool? ), bool? maintenanceMode = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Nullable<System.Boolean> |
loadColumnValues |
|
System.Nullable<System.Boolean> |
maintenanceMode |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTask>> GetFromControllerWorkflowTaskForWorkflowTaskAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, bool? loadColumnValues = default(bool? ), bool? maintenanceMode = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Nullable<System.Boolean> |
loadColumnValues |
|
System.Nullable<System.Boolean> |
maintenanceMode |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasksCount>> GetFromControllerWorkflowTasksCountForWorkflowTasksCountAsync(this ServiceConnection serviceConnection, string id)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasksCount>> GetFromControllerWorkflowTasksCountForWorkflowTasksCountAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasks>> GetFromControllerWorkflowTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, string id, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasks>> GetFromControllerWorkflowTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<CountResult>> GetFromCountResultForCountResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string dialogId, string fieldName = null, int? limit = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.String |
dialogId |
|
System.String |
fieldName |
|
System.Nullable<System.Int32> |
limit |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<CountResult>> GetFromCountResultForCountResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string dialogId, string fieldName = null, int? limit = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.String |
dialogId |
|
System.String |
fieldName |
|
System.Nullable<System.Int32> |
limit |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<CountResult>> GetFromCountTrashedDocumentsForCountResultAsync(this ServiceConnection serviceConnection)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<Dialog>> GetFromDialogForDialogAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, DialogTypes[] dialogType = null)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<Dialog>> GetFromDialogForDialogAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, DialogTypes[] dialogType = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
DialogTypes[] |
dialogType |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DialogInfos>> GetFromDialogsByFileCabinetForDialogInfosAsync(this ServiceConnection serviceConnection, string fileCabinetId, DialogTypes[] dialogType = null)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<DialogInfos>> GetFromDialogsByFileCabinetForDialogInfosAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, DialogTypes[] dialogType = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
DialogTypes[] |
dialogType |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DialogInfos>> GetFromDialogsForDialogInfosAsync(this ServiceConnection serviceConnection, DialogTypes[] dialogType = null)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentAnnotations>> GetFromDocumentAnnotationsForDocumentAnnotationsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentAnnotations>> GetFromDocumentAnnotationsForDocumentAnnotationsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetFromDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentAuditInformation>> GetFromDocumentAuditInformationForDocumentAuditInformationAsync(this ServiceConnection serviceConnection, string fileCabinetId, int id, DateTime? fromDate = default(DateTime? ), DateTime? toDate = default(DateTime? ), string format = null, int? start = default(int? ), int? count = default(int? ), string fcName = null, string delimiter = null, bool? isUtc = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.Int32 |
id |
|
System.Nullable<System.DateTime> |
fromDate |
|
System.Nullable<System.DateTime> |
toDate |
|
System.String |
format |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
fcName |
|
System.String |
delimiter |
|
System.Nullable<System.Boolean> |
isUtc |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentAuditInformation>> GetFromDocumentAuditInformationForDocumentAuditInformationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, int id, DateTime? fromDate = default(DateTime? ), DateTime? toDate = default(DateTime? ), string format = null, int? start = default(int? ), int? count = default(int? ), string fcName = null, string delimiter = null, bool? isUtc = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.Int32 |
id |
|
System.Nullable<System.DateTime> |
fromDate |
|
System.Nullable<System.DateTime> |
toDate |
|
System.String |
format |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
fcName |
|
System.String |
delimiter |
|
System.Nullable<System.Boolean> |
isUtc |
|
Returns
GetFromDocumentContentForStreamAsync(ServiceConnection, Int32, String, Int32[])
Declaration
public static Task<DeserializedHttpResponse<Stream>> GetFromDocumentContentForStreamAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, int[] append = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Int32[] |
append |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentLinks>> GetFromDocumentDocumentLinksForDocumentLinksAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentLinks>> GetFromDocumentDocumentLinksForDocumentLinksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Document>> GetFromDocumentForDocumentAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Document>> GetFromDocumentForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> GetFromDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> GetFromDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Document>> GetFromDocumentLatestVersionForDocumentAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Stream>> GetFromDocumentsFileDownloadForStreamAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, FileDownloadType? targetFileType = default(FileDownloadType? ), bool? keepAnnotations = default(bool? ), bool? downloadFile = default(bool? ), bool? autoPrint = default(bool? ), int[] layers = null, int[] append = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<FileDownloadType> |
targetFileType |
|
System.Nullable<System.Boolean> |
keepAnnotations |
|
System.Nullable<System.Boolean> |
downloadFile |
|
System.Nullable<System.Boolean> |
autoPrint |
|
System.Int32[] |
layers |
|
System.Int32[] |
append |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Stream>> GetFromDocumentsFileDownloadForStreamAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, FileDownloadType? targetFileType = default(FileDownloadType? ), bool? keepAnnotations = default(bool? ), bool? downloadFile = default(bool? ), bool? autoPrint = default(bool? ), int[] layers = null, int[] append = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<FileDownloadType> |
targetFileType |
|
System.Nullable<System.Boolean> |
keepAnnotations |
|
System.Nullable<System.Boolean> |
downloadFile |
|
System.Nullable<System.Boolean> |
autoPrint |
|
System.Int32[] |
layers |
|
System.Int32[] |
append |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> GetFromDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string q = null, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? msStart = default(int? ), int? count = default(int? ), string format = null, bool? includeSuggestions = default(bool? ), string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? calculateTotalCount = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.String |
q |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
msStart |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.Nullable<System.Boolean> |
includeSuggestions |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
calculateTotalCount |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> GetFromDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string q = null, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? msStart = default(int? ), int? count = default(int? ), string format = null, bool? includeSuggestions = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.String |
q |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
msStart |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.Nullable<System.Boolean> |
includeSuggestions |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFieldTable>> GetFromDocumentTableFieldRowsForDocumentIndexFieldTableAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, string tableFieldName, int? start = default(int? ), int? count = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.String |
tableFieldName |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<FileCabinet>> GetFromFileCabinetForFileCabinetAsync(this ServiceConnection serviceConnection, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<FileCabinet>> GetFromFileCabinetForFileCabinetAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<FileCabinets>> GetFromFileCabinetsForFileCabinetsAsync(this ServiceConnection serviceConnection)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<FileCabinets>> GetFromFileCabinetsForFileCabinetsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryTableResult>> GetFromFunctionExpressionForDocumentsQueryTableResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<SuggestionFields>> GetFromIntellixSuggestionsForSuggestionFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, bool? normalizeCoordinates = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<System.Boolean> |
normalizeCoordinates |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<SuggestionFields>> GetFromIntellixSuggestionsForSuggestionFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, bool? normalizeCoordinates = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<System.Boolean> |
normalizeCoordinates |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<MultiColSelectListInfo>> GetFromMultiColSelectListForMultiColSelectListInfoAsync(this ServiceConnection serviceConnection, string selectListId)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<MultiColSelectListInfo>> GetFromMultiColSelectListForMultiColSelectListInfoAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string selectListId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
selectListId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<MultiColSelectListInfos>> GetFromMultiColSelectListsForMultiColSelectListInfosAsync(this ServiceConnection serviceConnection)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<MultiColSelectListInfos>> GetFromMultiColSelectListsForMultiColSelectListInfosAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetFromMultiColSelectListValuesForMultiColSelectListValuesResultAsync(this ServiceConnection serviceConnection, string selectListId, int? start = default(int? ), int? count = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
selectListId |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetFromMultiColSelectListValuesForMultiColSelectListValuesResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string selectListId, int? start = default(int? ), int? count = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
selectListId |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
Returns
GetFromPagesBlockForPagesAsync(ServiceConnection, String, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<Pages>> GetFromPagesBlockForPagesAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int? start = default(int? ), int? count = default(int? ), bool? embedThumbnailData = default(bool? ), string thumbnailSize = null, bool? thumbnailsOnly = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.Nullable<System.Boolean> |
embedThumbnailData |
|
System.String |
thumbnailSize |
|
System.Nullable<System.Boolean> |
thumbnailsOnly |
|
Returns
GetFromPagesBlockForPagesAsync(ServiceConnection, CancellationToken, String, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<Pages>> GetFromPagesBlockForPagesAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int? start = default(int? ), int? count = default(int? ), bool? embedThumbnailData = default(bool? ), string thumbnailSize = null, bool? thumbnailsOnly = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.Nullable<System.Boolean> |
embedThumbnailData |
|
System.String |
thumbnailSize |
|
System.Nullable<System.Boolean> |
thumbnailsOnly |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> GetFromQueryDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string q = null, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string additionalCabinets = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? includeSuggestions = default(bool? ), bool? calculateTotalCount = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.String |
q |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
additionalCabinets |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
includeSuggestions |
|
System.Nullable<System.Boolean> |
calculateTotalCount |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<RequestTasks>> GetFromRequestTasksForRequestTasksAsync(this ServiceConnection serviceConnection, int? start = default(int? ), int? count = default(int? ), string sortOrder = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
sortOrder |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<RequestTasks>> GetFromRequestTasksForRequestTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int? start = default(int? ), int? count = default(int? ), string sortOrder = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
sortOrder |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Stream>> GetFromSectionFileDownloadForStreamAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, FileDownloadType? targetFileType = default(FileDownloadType? ), bool? keepAnnotations = default(bool? ), bool? downloadFile = default(bool? ), bool? autoPrint = default(bool? ), bool? sendByEmail = default(bool? ), int[] layers = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<FileDownloadType> |
targetFileType |
|
System.Nullable<System.Boolean> |
keepAnnotations |
|
System.Nullable<System.Boolean> |
downloadFile |
|
System.Nullable<System.Boolean> |
autoPrint |
|
System.Nullable<System.Boolean> |
sendByEmail |
|
System.Int32[] |
layers |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Section>> GetFromSectionForSectionAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, string thumbnailSize, bool? embedThumbnailData = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.String |
thumbnailSize |
|
System.Nullable<System.Boolean> |
embedThumbnailData |
|
Returns
GetFromSectionPageForPageAsync(ServiceConnection, String, String, Int32)
Declaration
public static Task<DeserializedHttpResponse<Page>> GetFromSectionPageForPageAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WordSearchResult>> GetFromSectionPositionsForWordSearchResultAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, string q, bool? wholeWord = default(bool? ), bool? ignoreCase = default(bool? ), int? startSectionNumber = default(int? ), int? startPage = default(int? ), int? pageCount = default(int? ), bool? rangeSearch = default(bool? ), bool? backward = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.String |
q |
|
System.Nullable<System.Boolean> |
wholeWord |
|
System.Nullable<System.Boolean> |
ignoreCase |
|
System.Nullable<System.Int32> |
startSectionNumber |
|
System.Nullable<System.Int32> |
startPage |
|
System.Nullable<System.Int32> |
pageCount |
|
System.Nullable<System.Boolean> |
rangeSearch |
|
System.Nullable<System.Boolean> |
backward |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Sections>> GetFromSectionsForSectionsAsync(this ServiceConnection serviceConnection, int docid, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
docid |
|
System.String |
fileCabinetId |
|
Returns
GetFromSectionTextAnnotationForStringAsync(ServiceConnection, String, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<string>> GetFromSectionTextAnnotationForStringAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, bool? ignoreMe = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<System.Boolean> |
ignoreMe |
|
Returns
GetFromSectionTextshotForDocumentContentAsync(ServiceConnection, String, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<DocumentContent>> GetFromSectionTextshotForDocumentContentAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, bool? skipNotExisting = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Nullable<System.Boolean> |
skipNotExisting |
|
Returns
GetFromSectionTextshotPageForPageContentAsync(ServiceConnection, String, String, Int32, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<PageContent>> GetFromSectionTextshotPageForPageContentAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, bool? flat = default(bool? ), bool? normalize = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
System.Nullable<System.Boolean> |
flat |
|
System.Nullable<System.Boolean> |
normalize |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<SelectListInfo>> GetFromSelectListForSelectListInfoAsync(this ServiceConnection serviceConnection, string id, string selectListId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
selectListId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<SelectListInfo>> GetFromSelectListForSelectListInfoAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string selectListId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String |
selectListId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<SelectListValuesResult>> GetFromSelectListValuesForSelectListValuesResultAsync(this ServiceConnection serviceConnection, string selectListId, int? start = default(int? ), int? count = default(int? ), string prefix = null, string returnType = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
selectListId |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
prefix |
|
System.String |
returnType |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetFromSingleColumnSelectListValuesResultForSingleColumnSelectListValuesAsync(this ServiceConnection serviceConnection, string selectListId, int? start = default(int? ), int? count = default(int? ), string prefix = null, string returnType = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
selectListId |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
prefix |
|
System.String |
returnType |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasksCount>> GetFromTasksCountForWorkflowTasksCountAsync(this ServiceConnection serviceConnection, string id)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasksCount>> GetFromTasksCountForWorkflowTasksCountAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasks>> GetFromTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, string id, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasks>> GetFromTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
GetFromTextshotPreviewForStringAsync(ServiceConnection, Int32, String, String)
Declaration
public static Task<DeserializedHttpResponse<string>> GetFromTextshotPreviewForStringAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, string fullTextQuery)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.String |
fullTextQuery |
|
Returns
GetFromTextshotPreviewForStringAsync(ServiceConnection, Int32, String, String, Boolean)
Declaration
public static Task<DeserializedHttpResponse<string>> GetFromTextshotPreviewForStringAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, string fullTextQuery, bool addWildcards)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.String |
fullTextQuery |
|
System.Boolean |
addWildcards |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<TrashBin>> GetFromTrashBinForTrashBinAsync(this ServiceConnection serviceConnection)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetFromTrashedDocumentsForTrashBinDocumentsTableResultAsync(this ServiceConnection serviceConnection, string q = null, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), bool? calculateTotalCount = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
q |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.Nullable<System.Boolean> |
calculateTotalCount |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<User>> GetFromUsersForUserByExternalIdAsync(this ServiceConnection serviceConnection, string userExternalId, string externalProvider = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
userExternalId |
|
System.String |
externalProvider |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<User>> GetFromUsersForUserByIdAsync(this ServiceConnection serviceConnection, string userId)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<Roles>> GetFromUsersForUserRolesAsync(this ServiceConnection serviceConnection, string userId, bool? active = default(bool? ), string type = null, string name = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
userId |
|
System.Nullable<System.Boolean> |
active |
|
System.String |
type |
|
System.String |
name |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Users>> GetFromUsersForUsersByRoleAsync(this ServiceConnection serviceConnection, string roleId, bool? includeGroupUsers = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
roleId |
|
System.Nullable<System.Boolean> |
includeGroupUsers |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Decision>> GetFromWorkflowDecisionsForDecisionAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, int decisionId, bool? ignoreErrors = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Int32 |
decisionId |
|
System.Nullable<System.Boolean> |
ignoreErrors |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Decision>> GetFromWorkflowDecisionsForDecisionAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, int decisionId, bool? ignoreErrors = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Int32 |
decisionId |
|
System.Nullable<System.Boolean> |
ignoreErrors |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Workflow>> GetFromWorkflowForWorkflowAsync(this ServiceConnection serviceConnection, string id, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Workflow>> GetFromWorkflowForWorkflowAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Instance>> GetFromWorkflowInstanceForInstanceAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Instance>> GetFromWorkflowInstanceForInstanceAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<RequestTask>> GetFromWorkflowRequestTaskForRequestTaskAsync(this ServiceConnection serviceConnection, string workflowId, string taskId, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
taskId |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<RequestTask>> GetFromWorkflowRequestTaskForRequestTaskAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string taskId, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
taskId |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Workflows>> GetFromWorkflowsForWorkflowsAsync(this ServiceConnection serviceConnection, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Workflows>> GetFromWorkflowsForWorkflowsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTask>> GetFromWorkflowTaskForWorkflowTaskAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, bool? loadColumnValues = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Nullable<System.Boolean> |
loadColumnValues |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<WorkflowTask>> GetFromWorkflowTaskForWorkflowTaskAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, bool? loadColumnValues = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Nullable<System.Boolean> |
loadColumnValues |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Group>> GetGroupFromGroupAsync(this ServiceConnection serviceConnection, string groupId)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<Group>> GetGroupFromGroupAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string groupId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
groupId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsQueryParamsAsync(this ServiceConnection serviceConnection, bool? active = default(bool? ), string name = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Nullable<System.Boolean> |
active |
|
System.String |
name |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesQueryParamsAsync(this ServiceConnection serviceConnection, bool? active = default(bool? ), string name = null, string type = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Nullable<System.Boolean> |
active |
|
System.String |
name |
|
System.String |
type |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Groups>> GetUserGroupsFromUserGroupsQueryParamsAsync(this ServiceConnection serviceConnection, string userId = null, bool? active = default(bool? ), string name = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
userId |
|
System.Nullable<System.Boolean> |
active |
|
System.String |
name |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Users>> GetUsersFromUsersQueryParamsAsync(this ServiceConnection serviceConnection, bool? active = default(bool? ), string name = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Nullable<System.Boolean> |
active |
|
System.String |
name |
|
Returns
PostFilterUsersFromUsersQueryAsync(ServiceConnection, UsersQuery)
Declaration
public static Task<DeserializedHttpResponse<Users>> PostFilterUsersFromUsersQueryAsync(this ServiceConnection serviceConnection, UsersQuery data)
Parameters
Returns
PostFromSectionTextshotForStringAsync(ServiceConnection, String, String)
Declaration
public static Task<DeserializedHttpResponse<string>> PostFromSectionTextshotForStringAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
Returns
PostGroupFromCreateGroupAsync(ServiceConnection, Group)
Declaration
public static Task<DeserializedHttpResponse<Group>> PostGroupFromCreateGroupAsync(this ServiceConnection serviceConnection, Group data)
Parameters
Returns
PostGroupFromCreateGroupAsync(ServiceConnection, CancellationToken, Group)
Declaration
public static Task<DeserializedHttpResponse<Group>> PostGroupFromCreateGroupAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, Group data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
Group |
data |
|
Returns
PostGroupsFromGroupsQueryAsync(ServiceConnection, GroupsQuery)
Declaration
public static Task<DeserializedHttpResponse<Groups>> PostGroupsFromGroupsQueryAsync(this ServiceConnection serviceConnection, GroupsQuery data)
Parameters
Returns
PostRolesFromRolesQueryAsync(ServiceConnection, RolesQuery)
Declaration
public static Task<DeserializedHttpResponse<Roles>> PostRolesFromRolesQueryAsync(this ServiceConnection serviceConnection, RolesQuery data)
Parameters
Returns
PostToAnnotationForAnnotationAsync(ServiceConnection, String, String, Int32, Annotation)
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PostToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, Annotation data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
Annotation |
data |
|
Returns
PostToAnnotationForAnnotationAsync(ServiceConnection, String, String, Int32, AnnotationsPlacement)
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PostToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, AnnotationsPlacement data)
Parameters
Returns
PostToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, String, String, Int32, Annotation)
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PostToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page, Annotation data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
Annotation |
data |
|
Returns
PostToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, String, String, Int32, AnnotationsPlacement)
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PostToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page, AnnotationsPlacement data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
AnnotationsPlacement |
data |
|
Returns
PostToArchiveDocumentForStreamAsync(ServiceConnection, String, Int32, ExportSettings)
Declaration
public static Task<DeserializedHttpResponse<Stream>> PostToArchiveDocumentForStreamAsync(this ServiceConnection serviceConnection, string fileCabinetId, int id, ExportSettings data)
Parameters
Returns
PostToAreValuesInSelectListForAreValuesInSelectListsResultAsync(ServiceConnection, String, SelectListValuesToCheck)
Declaration
public static Task<DeserializedHttpResponse<AreValuesInSelectListsResult>> PostToAreValuesInSelectListForAreValuesInSelectListsResultAsync(this ServiceConnection serviceConnection, string selectListId, SelectListValuesToCheck data)
Parameters
Returns
PostToBatchDeleteForBatchDeleteResultAsync(ServiceConnection, BatchDeleteDocumentsSource)
Declaration
public static Task<DeserializedHttpResponse<BatchDeleteResult>> PostToBatchDeleteForBatchDeleteResultAsync(this ServiceConnection serviceConnection, BatchDeleteDocumentsSource data)
Parameters
Returns
PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, String, String, BatchUpdateProcess, String[], String[])
Declaration
public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string id, BatchUpdateProcess data, string[] fields = null, string[] sortOrder = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.String |
id |
|
BatchUpdateProcess |
data |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
Returns
PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, CancellationToken, String, String, BatchUpdateProcess, String[], String[])
Declaration
public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string id, BatchUpdateProcess data, string[] fields = null, string[] sortOrder = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.String |
id |
|
BatchUpdateProcess |
data |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
Returns
PostToBatchQueryUpdateFieldsOperationForBatchUpdateIndexFieldsResultAsync(ServiceConnection, String, BatchUpdateProcessData, String[], String[], String, Nullable<Int32>)
Declaration
public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchQueryUpdateFieldsOperationForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, BatchUpdateProcessData data, string[] fields = null, string[] sortOrder = null, string q = null, int? start = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
BatchUpdateProcessData |
data |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.String |
q |
|
System.Nullable<System.Int32> |
start |
|
Returns
PostToBatchRestoreForBatchRestoreResultAsync(ServiceConnection, BatchRestoreDocumentsSource)
Declaration
public static Task<DeserializedHttpResponse<BatchRestoreResult>> PostToBatchRestoreForBatchRestoreResultAsync(this ServiceConnection serviceConnection, BatchRestoreDocumentsSource data)
Parameters
Returns
PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, String, BatchAppendKeywordValues)
Declaration
public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, BatchAppendKeywordValues data)
Parameters
Returns
PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, String, BatchUpdateProcess)
Declaration
public static Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, BatchUpdateProcess data)
Parameters
Returns
PostToCheckinForDocumentAsync(ServiceConnection, Int32, String, MultipartFormDataContent)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToCheckinForDocumentAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, MultipartFormDataContent data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Net.Http.MultipartFormDataContent |
data |
|
Returns
PostToCheckinForDocumentAsync(ServiceConnection, CancellationToken, Int32, String, MultipartFormDataContent)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToCheckinForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, MultipartFormDataContent data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Net.Http.MultipartFormDataContent |
data |
|
Returns
PostToCheckoutDocumentForCheckOutResultAsync(ServiceConnection, Int32, String, CheckOutToFileSystemInfo)
Declaration
public static Task<DeserializedHttpResponse<CheckOutResult>> PostToCheckoutDocumentForCheckOutResultAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, CheckOutToFileSystemInfo data)
Parameters
Returns
PostToCheckoutDocumentForCheckOutResultAsync(ServiceConnection, CancellationToken, Int32, String, CheckOutToFileSystemInfo)
Declaration
public static Task<DeserializedHttpResponse<CheckOutResult>> PostToCheckoutDocumentForCheckOutResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, CheckOutToFileSystemInfo data)
Parameters
Returns
PostToCheckoutForStreamAsync(ServiceConnection, Int32, String, CheckOutToFileSystemInfo)
Declaration
public static Task<DeserializedHttpResponse<Stream>> PostToCheckoutForStreamAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, CheckOutToFileSystemInfo data)
Parameters
Returns
PostToCheckoutForStreamAsync(ServiceConnection, CancellationToken, Int32, String, CheckOutToFileSystemInfo)
Declaration
public static Task<DeserializedHttpResponse<Stream>> PostToCheckoutForStreamAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, CheckOutToFileSystemInfo data)
Parameters
Returns
PostToClippedDocumentsForDocumentAsync(ServiceConnection, Int32, String, IntegerList, Nullable<ContentMergeOperation>)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToClippedDocumentsForDocumentAsync(this ServiceConnection serviceConnection, int docId, string fileCabinetId, IntegerList data, ContentMergeOperation? operation = default(ContentMergeOperation? ))
Parameters
Returns
PostToClippedDocumentsForDocumentAsync(ServiceConnection, CancellationToken, Int32, String, IntegerList, Nullable<ContentMergeOperation>)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToClippedDocumentsForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int docId, string fileCabinetId, IntegerList data, ContentMergeOperation? operation = default(ContentMergeOperation? ))
Parameters
Returns
PostToContentDivideForDocumentsQueryResultAsync(ServiceConnection, String, Int32, ContentDivideOperationInfo)
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToContentDivideForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, int docId, ContentDivideOperationInfo data)
Parameters
Returns
PostToContentMergeForDocumentAsync(ServiceConnection, String, ContentMergeOperationInfo)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToContentMergeForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, ContentMergeOperationInfo data)
Parameters
Returns
PostToControllerWorkflowConfirmForStringAsync(ServiceConnection, String, String, String, Int32, ConfirmedData)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToControllerWorkflowConfirmForStringAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, int decisionId, ConfirmedData data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Int32 |
decisionId |
|
ConfirmedData |
data |
|
Returns
PostToControllerWorkflowConfirmForStringAsync(ServiceConnection, CancellationToken, String, String, String, Int32, ConfirmedData)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToControllerWorkflowConfirmForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, int decisionId, ConfirmedData data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Int32 |
decisionId |
|
ConfirmedData |
data |
|
Returns
PostToControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, String, TasksQuery, String[], Nullable<Int32>, Nullable<Int32>, String, String, String, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasks>> PostToControllerWorkflowTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, string id, TasksQuery data, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
TasksQuery |
data |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
PostToControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, String, TasksQuery, String[], Nullable<Int32>, Nullable<Int32>, String, String, String, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasks>> PostToControllerWorkflowTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, TasksQuery data, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
TasksQuery |
data |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
PostToCreatePermanentUrlForStringAsync(ServiceConnection, FormUrlEncodedContent, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToCreatePermanentUrlForStringAsync(this ServiceConnection serviceConnection, FormUrlEncodedContent data, bool? clientSideChecksum = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Net.Http.FormUrlEncodedContent |
data |
|
System.Nullable<System.Boolean> |
clientSideChecksum |
|
Returns
PostToCreatePermanentUrlForStringAsync(ServiceConnection, CancellationToken, FormUrlEncodedContent, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToCreatePermanentUrlForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, FormUrlEncodedContent data, bool? clientSideChecksum = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Net.Http.FormUrlEncodedContent |
data |
|
System.Nullable<System.Boolean> |
clientSideChecksum |
|
Returns
PostToCreateUserDefinedSearchForDialogAsync(ServiceConnection, String, String, UserDefinedSearchInfo)
Declaration
public static Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchForDialogAsync(this ServiceConnection serviceConnection, string fileCabinetId, string id, UserDefinedSearchInfo data)
Parameters
Returns
PostToCreateUserDefinedSearchForDialogAsync(ServiceConnection, CancellationToken, String, String, UserDefinedSearchInfo)
Declaration
public static Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchForDialogAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string id, UserDefinedSearchInfo data)
Parameters
Returns
PostToDialogExpressionForDocumentsQueryResultAsync(ServiceConnection, String, String, DialogExpression, String[], String[], Nullable<Int32>, Nullable<Int32>)
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToDialogExpressionForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string dialogId, DialogExpression data, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.String |
dialogId |
|
DialogExpression |
data |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
Returns
PostToDialogExpressionForDocumentsQueryResultAsync(ServiceConnection, CancellationToken, String, String, DialogExpression, String[], String[], Nullable<Int32>, Nullable<Int32>)
Declaration
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 = default(int? ), int? count = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.String |
dialogId |
|
DialogExpression |
data |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
Returns
PostToDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, Int32, String, DocumentAnnotationsPlacement)
Declaration
public static Task<DeserializedHttpResponse<DocumentAnnotations>> PostToDocumentAnnotationsForDocumentAnnotationsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, DocumentAnnotationsPlacement data)
Parameters
Returns
PostToDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, CancellationToken, Int32, String, DocumentAnnotationsPlacement)
Declaration
public static Task<DeserializedHttpResponse<DocumentAnnotations>> PostToDocumentAnnotationsForDocumentAnnotationsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, DocumentAnnotationsPlacement data)
Parameters
Returns
PostToDocumentAppendFilesForDocumentAsync(ServiceConnection, Int32, String, MultipartFormDataContent)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToDocumentAppendFilesForDocumentAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, MultipartFormDataContent data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Net.Http.MultipartFormDataContent |
data |
|
Returns
PostToDocumentAppendFilesForDocumentAsync(ServiceConnection, CancellationToken, Int32, String, MultipartFormDataContent)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToDocumentAppendFilesForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, MultipartFormDataContent data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
System.Net.Http.MultipartFormDataContent |
data |
|
Returns
PostToDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(ServiceConnection, Int32, String, DocumentApplicationProperties)
Declaration
public static Task<DeserializedHttpResponse<DocumentApplicationProperties>> PostToDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, DocumentApplicationProperties data)
Parameters
Returns
PostToDocumentDeleteVersionHistoryForStringAsync(ServiceConnection, Int32, String)
Deletes the version history of the document.
Declaration
[Wolf]
public static Task<DeserializedHttpResponse<string>> PostToDocumentDeleteVersionHistoryForStringAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
The service connection
|
System.Int32 |
id |
The id of the document
|
System.String |
fileCabinetId |
The id of the file cabinet
|
Returns
PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, Int32, String, DocumentIndexFields)
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, DocumentIndexFields data)
Parameters
Returns
PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, Int32, String, UpdateIndexFieldsInfo)
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, UpdateIndexFieldsInfo data)
Parameters
Returns
PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, Int32, String, DocumentIndexFields)
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, DocumentIndexFields data)
Parameters
Returns
PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, Int32, String, UpdateIndexFieldsInfo)
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, UpdateIndexFieldsInfo data)
Parameters
Returns
PostToDocumentlessTriggerForStringAsync(ServiceConnection, String, DocumentlessTriggerData)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToDocumentlessTriggerForStringAsync(this ServiceConnection serviceConnection, string workflowId, DocumentlessTriggerData data)
Parameters
Returns
PostToDocumentlessTriggerForStringAsync(ServiceConnection, CancellationToken, String, DocumentlessTriggerData)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToDocumentlessTriggerForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, DocumentlessTriggerData data)
Parameters
Returns
PostToDocumentRightsForRightsAsync(ServiceConnection, Int32, String, Rights)
Declaration
public static Task<DeserializedHttpResponse<Rights>> PostToDocumentRightsForRightsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, Rights data)
Parameters
Returns
PostToDocumentRightsForRightsAsync(ServiceConnection, CancellationToken, Int32, String, Rights)
Declaration
public static Task<DeserializedHttpResponse<Rights>> PostToDocumentRightsForRightsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, Rights data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.Int32 |
id |
|
System.String |
fileCabinetId |
|
Rights |
data |
|
Returns
PostToExportForStreamAsync(ServiceConnection, String, ExportSettings, String, String[], String[])
Declaration
public static Task<DeserializedHttpResponse<Stream>> PostToExportForStreamAsync(this ServiceConnection serviceConnection, string fileCabinetId, ExportSettings data, string q = null, string[] fields = null, string[] sortOrder = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
ExportSettings |
data |
|
System.String |
q |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
Returns
PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(ServiceConnection, String, SelectListExpression)
Declaration
public static Task<DeserializedHttpResponse<FieldValueStatisticsResult>> PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, SelectListExpression data)
Parameters
Returns
PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(ServiceConnection, CancellationToken, String, SelectListExpression)
Declaration
public static Task<DeserializedHttpResponse<FieldValueStatisticsResult>> PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, SelectListExpression data)
Parameters
Returns
PostToFunctionExpressionForDocumentsQueryTableResultAsync(ServiceConnection, String, FunctionExpressionQuery, String[], String[], Nullable<Int32>, Nullable<Int32>)
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryTableResult>> PostToFunctionExpressionForDocumentsQueryTableResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, FunctionExpressionQuery data, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
FunctionExpressionQuery |
data |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
Returns
PostToImportDocumentForImportResultAsync(ServiceConnection, String, Stream)
Declaration
public static Task<DeserializedHttpResponse<ImportResult>> PostToImportDocumentForImportResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, Stream data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.IO.Stream |
data |
|
Returns
PostToImportDocumentForImportResultAsync(ServiceConnection, CancellationToken, String, Stream)
Declaration
public static Task<DeserializedHttpResponse<ImportResult>> PostToImportDocumentForImportResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, Stream data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.IO.Stream |
data |
|
Returns
PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(ServiceConnection, String, MultiColSelectListValuesQuery)
Declaration
public static Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(this ServiceConnection serviceConnection, string selectListId, MultiColSelectListValuesQuery data)
Parameters
Returns
PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(ServiceConnection, CancellationToken, String, MultiColSelectListValuesQuery)
Declaration
public static Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string selectListId, MultiColSelectListValuesQuery data)
Parameters
Returns
PostToMultiColumnSelectListValuesForSelectListValuesResultAsync(ServiceConnection, String, MultiColumnSelectListValuesQuery)
Declaration
public static Task<DeserializedHttpResponse<SelectListValuesResult>> PostToMultiColumnSelectListValuesForSelectListValuesResultAsync(this ServiceConnection serviceConnection, string selectListId, MultiColumnSelectListValuesQuery data)
Parameters
Returns
PostToQueryDocumentsForDocumentsQueryResultAsync(ServiceConnection, String, DocumentLinkExpressionQuery, String, String[], String[], Nullable<Int32>, Nullable<Int32>, String, String, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToQueryDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, DocumentLinkExpressionQuery data, string q = null, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string additionalCabinets = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? includeSuggestions = default(bool? ), bool? calculateTotalCount = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
DocumentLinkExpressionQuery |
data |
|
System.String |
q |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
additionalCabinets |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
includeSuggestions |
|
System.Nullable<System.Boolean> |
calculateTotalCount |
|
Returns
PostToQueryDocumentsForDocumentsQueryResultAsync(ServiceConnection, String, ResultListQuery, String, String[], String[], Nullable<Int32>, Nullable<Int32>, String, String, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToQueryDocumentsForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, ResultListQuery data, string q = null, string[] fields = null, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string additionalCabinets = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? includeSuggestions = default(bool? ), bool? calculateTotalCount = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
ResultListQuery |
data |
|
System.String |
q |
|
System.String[] |
fields |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
additionalCabinets |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
includeSuggestions |
|
System.Nullable<System.Boolean> |
calculateTotalCount |
|
Returns
PostToQueryTrashedDocumentsForTrashBinDocumentsTableResultAsync(ServiceConnection, TrashBinQuery)
Declaration
public static Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> PostToQueryTrashedDocumentsForTrashBinDocumentsTableResultAsync(this ServiceConnection serviceConnection, TrashBinQuery data)
Parameters
Returns
PostToRequestTasksForRequestTasksAsync(ServiceConnection, TasksQuery, Nullable<Int32>, Nullable<Int32>, String, String, String, String, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<RequestTasks>> PostToRequestTasksForRequestTasksAsync(this ServiceConnection serviceConnection, TasksQuery data, int? start = default(int? ), int? count = default(int? ), string sortOrder = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
TasksQuery |
data |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
sortOrder |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
PostToRequestTasksForRequestTasksAsync(ServiceConnection, CancellationToken, TasksQuery, Nullable<Int32>, Nullable<Int32>, String, String, String, String, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<RequestTasks>> PostToRequestTasksForRequestTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, TasksQuery data, int? start = default(int? ), int? count = default(int? ), string sortOrder = null, string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
TasksQuery |
data |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
sortOrder |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
PostToRetrieveSequenceElementForSequenceResultAsync(ServiceConnection, String, SequenceRequest)
Declaration
public static Task<DeserializedHttpResponse<SequenceResult>> PostToRetrieveSequenceElementForSequenceResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, SequenceRequest data)
Parameters
Returns
PostToRetrieveSequenceElementForSequenceResultAsync(ServiceConnection, CancellationToken, String, SequenceRequest)
Declaration
public static Task<DeserializedHttpResponse<SequenceResult>> PostToRetrieveSequenceElementForSequenceResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, SequenceRequest data)
Parameters
Returns
PostToSectionPagesBlockResultForPagesAsync(ServiceConnection, String, String, PagesBlockQuery)
Declaration
public static Task<DeserializedHttpResponse<Pages>> PostToSectionPagesBlockResultForPagesAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, PagesBlockQuery data)
Parameters
Returns
PostToSectionStampBestPositionForDWPointAsync(ServiceConnection, String, String, Int32, StampFormFieldValues)
Declaration
public static Task<DeserializedHttpResponse<DWPoint>> PostToSectionStampBestPositionForDWPointAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, StampFormFieldValues data)
Parameters
Returns
PostToSectionStampForAnnotationAsync(ServiceConnection, String, String, Int32, StampPlacement)
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PostToSectionStampForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, StampPlacement data)
Parameters
Returns
PostToSelectListExpressionForSelectListResultAsync(ServiceConnection, String, String, String, String, SelectListExpression)
Declaration
public static Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListExpressionForSelectListResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string dialogId, string fieldName, string parentFieldName, SelectListExpression data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.String |
dialogId |
|
System.String |
fieldName |
|
System.String |
parentFieldName |
|
SelectListExpression |
data |
|
Returns
PostToSelectListExpressionForSelectListResultAsync(ServiceConnection, CancellationToken, String, String, String, String, SelectListExpression)
Declaration
public static Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListExpressionForSelectListResultAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, string dialogId, string fieldName, string parentFieldName, SelectListExpression data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.String |
dialogId |
|
System.String |
fieldName |
|
System.String |
parentFieldName |
|
SelectListExpression |
data |
|
Returns
PostToSelectListValuesForSingleColumnSelectListValuesAsync(ServiceConnection, String, SelectListValuesQuery)
Declaration
public static Task<DeserializedHttpResponse<SingleColumnSelectListValues>> PostToSelectListValuesForSingleColumnSelectListValuesAsync(this ServiceConnection serviceConnection, string selectListId, SelectListValuesQuery data)
Parameters
Returns
PostToTasksForWorkflowTasksAsync(ServiceConnection, String, TasksQuery, String[], Nullable<Int32>, Nullable<Int32>, String, String, String, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasks>> PostToTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, string id, TasksQuery data, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
TasksQuery |
data |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
PostToTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, String, TasksQuery, String[], Nullable<Int32>, Nullable<Int32>, String, String, String, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<WorkflowTasks>> PostToTasksForWorkflowTasksAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, TasksQuery data, string[] sortOrder = null, int? start = default(int? ), int? count = default(int? ), string format = null, string encodingName = null, string csvDelimiter = null, bool? csvIsUtc = default(bool? ), bool? removeLinks = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
TasksQuery |
data |
|
System.String[] |
sortOrder |
|
System.Nullable<System.Int32> |
start |
|
System.Nullable<System.Int32> |
count |
|
System.String |
format |
|
System.String |
encodingName |
|
System.String |
csvDelimiter |
|
System.Nullable<System.Boolean> |
csvIsUtc |
|
System.Nullable<System.Boolean> |
removeLinks |
|
Returns
PostToTransferForDocumentsQueryResultAsync(ServiceConnection, String, String, DocumentsTransferInfo)
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToTransferForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string storeDialogId, DocumentsTransferInfo data)
Parameters
Returns
PostToTransferForDocumentsQueryResultAsync(ServiceConnection, String, String, FileCabinetTransferInfo)
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToTransferForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, string storeDialogId, FileCabinetTransferInfo data)
Parameters
Returns
PostToUploadDocumentForDocumentAsync(ServiceConnection, String, Document, Nullable<Boolean>, Nullable<Boolean>, String, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, Document data, bool? processTextshot = default(bool? ), bool? imageProcessing = default(bool? ), string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
Document |
data |
|
System.Nullable<System.Boolean> |
processTextshot |
|
System.Nullable<System.Boolean> |
imageProcessing |
|
System.String |
redirect |
|
System.String |
storeDialogId |
|
System.Nullable<System.Boolean> |
checkFileNameForCheckinInfo |
|
Returns
PostToUploadDocumentForDocumentAsync(ServiceConnection, String, InputDocument, Nullable<Boolean>, Nullable<Boolean>, String, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, InputDocument data, bool? processTextshot = default(bool? ), bool? imageProcessing = default(bool? ), string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
InputDocument |
data |
|
System.Nullable<System.Boolean> |
processTextshot |
|
System.Nullable<System.Boolean> |
imageProcessing |
|
System.String |
redirect |
|
System.String |
storeDialogId |
|
System.Nullable<System.Boolean> |
checkFileNameForCheckinInfo |
|
Returns
PostToUploadDocumentForDocumentAsync(ServiceConnection, String, Stream, Nullable<Boolean>, Nullable<Boolean>, String, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, Stream data, bool? processTextshot = default(bool? ), bool? imageProcessing = default(bool? ), string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
fileCabinetId |
|
System.IO.Stream |
data |
|
System.Nullable<System.Boolean> |
processTextshot |
|
System.Nullable<System.Boolean> |
imageProcessing |
|
System.String |
redirect |
|
System.String |
storeDialogId |
|
System.Nullable<System.Boolean> |
checkFileNameForCheckinInfo |
|
Returns
PostToUploadDocumentForDocumentAsync(ServiceConnection, CancellationToken, String, Document, Nullable<Boolean>, Nullable<Boolean>, String, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, Document data, bool? processTextshot = default(bool? ), bool? imageProcessing = default(bool? ), string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
Document |
data |
|
System.Nullable<System.Boolean> |
processTextshot |
|
System.Nullable<System.Boolean> |
imageProcessing |
|
System.String |
redirect |
|
System.String |
storeDialogId |
|
System.Nullable<System.Boolean> |
checkFileNameForCheckinInfo |
|
Returns
PostToUploadDocumentForDocumentAsync(ServiceConnection, CancellationToken, String, Stream, Nullable<Boolean>, Nullable<Boolean>, String, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<Document>> PostToUploadDocumentForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, Stream data, bool? processTextshot = default(bool? ), bool? imageProcessing = default(bool? ), string redirect = null, string storeDialogId = null, bool? checkFileNameForCheckinInfo = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.IO.Stream |
data |
|
System.Nullable<System.Boolean> |
processTextshot |
|
System.Nullable<System.Boolean> |
imageProcessing |
|
System.String |
redirect |
|
System.String |
storeDialogId |
|
System.Nullable<System.Boolean> |
checkFileNameForCheckinInfo |
|
Returns
PostToUsersForUserRolesAsync(ServiceConnection, UserRolesQuery, String, Nullable<Boolean>, String, String)
Declaration
public static Task<DeserializedHttpResponse<Roles>> PostToUsersForUserRolesAsync(this ServiceConnection serviceConnection, UserRolesQuery data, string userId, bool? active = default(bool? ), string type = null, string name = null)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
UserRolesQuery |
data |
|
System.String |
userId |
|
System.Nullable<System.Boolean> |
active |
|
System.String |
type |
|
System.String |
name |
|
Returns
PostToUsersForUsersByRoleAsync(ServiceConnection, UsersByRole, String, Nullable<Boolean>)
Declaration
public static Task<DeserializedHttpResponse<Users>> PostToUsersForUsersByRoleAsync(this ServiceConnection serviceConnection, UsersByRole data, string roleId, bool? includeGroupUsers = default(bool? ))
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
UsersByRole |
data |
|
System.String |
roleId |
|
System.Nullable<System.Boolean> |
includeGroupUsers |
|
Returns
PostToValidateUserForStringAsync(ServiceConnection, String, UserValidation)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToValidateUserForStringAsync(this ServiceConnection serviceConnection, string id, UserValidation data)
Parameters
Returns
PostToValidateUserForStringAsync(ServiceConnection, CancellationToken, String, UserValidation)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToValidateUserForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, UserValidation data)
Parameters
Returns
PostToWorkflowConfirmForStringAsync(ServiceConnection, String, String, String, Int32, ConfirmedData)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToWorkflowConfirmForStringAsync(this ServiceConnection serviceConnection, string workflowId, string instanceId, string taskId, int decisionId, ConfirmedData data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Int32 |
decisionId |
|
ConfirmedData |
data |
|
Returns
PostToWorkflowConfirmForStringAsync(ServiceConnection, CancellationToken, String, String, String, Int32, ConfirmedData)
Declaration
public static Task<DeserializedHttpResponse<string>> PostToWorkflowConfirmForStringAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string workflowId, string instanceId, string taskId, int decisionId, ConfirmedData data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
workflowId |
|
System.String |
instanceId |
|
System.String |
taskId |
|
System.Int32 |
decisionId |
|
ConfirmedData |
data |
|
Returns
PostUserGroupsFromUserGroupsQueryAsync(ServiceConnection, UserGroupsQuery)
Declaration
public static Task<DeserializedHttpResponse<Groups>> PostUserGroupsFromUserGroupsQueryAsync(this ServiceConnection serviceConnection, UserGroupsQuery data)
Parameters
Returns
PutFromSectionTextshotForStringAsync(ServiceConnection, String, String)
Declaration
public static Task<DeserializedHttpResponse<string>> PutFromSectionTextshotForStringAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PutToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, Annotation data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
Annotation |
data |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PutToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, string id, string fileCabinetId, int page, AnnotationsPlacement data)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PutToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page, Annotation data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
Annotation |
data |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Annotation>> PutToAnnotationForAnnotationAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string id, string fileCabinetId, int page, AnnotationsPlacement data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
id |
|
System.String |
fileCabinetId |
|
System.Int32 |
page |
|
AnnotationsPlacement |
data |
|
Returns
PutToClippedDocumentsForDocumentAsync(ServiceConnection, Int32, String, IntegerList, Nullable<ContentMergeOperation>)
Declaration
public static Task<DeserializedHttpResponse<Document>> PutToClippedDocumentsForDocumentAsync(this ServiceConnection serviceConnection, int docId, string fileCabinetId, IntegerList data, ContentMergeOperation? operation = default(ContentMergeOperation? ))
Parameters
Returns
PutToContentDivideForDocumentsQueryResultAsync(ServiceConnection, String, Int32, ContentDivideOperationInfo)
Declaration
public static Task<DeserializedHttpResponse<DocumentsQueryResult>> PutToContentDivideForDocumentsQueryResultAsync(this ServiceConnection serviceConnection, string fileCabinetId, int docId, ContentDivideOperationInfo data)
Parameters
Returns
PutToContentMergeForDocumentAsync(ServiceConnection, String, ContentMergeOperationInfo)
Declaration
public static Task<DeserializedHttpResponse<Document>> PutToContentMergeForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, ContentMergeOperationInfo data)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, DocumentIndexFields data)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, int id, string fileCabinetId, UpdateIndexFieldsInfo data)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, DocumentIndexFields data)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<DocumentIndexFields>> PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, int id, string fileCabinetId, UpdateIndexFieldsInfo data)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<Document>> PutToProcessDocumentActionForDocumentAsync(this ServiceConnection serviceConnection, string fileCabinetId, int docId, DocumentActionInfo data)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<Document>> PutToProcessDocumentActionForDocumentAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, string fileCabinetId, int docId, DocumentActionInfo data)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
System.String |
fileCabinetId |
|
System.Int32 |
docId |
|
DocumentActionInfo |
data |
|
Returns
Declaration
public static Task<DeserializedHttpResponse<Group>> PutToUpdateGroupForGroupAsync(this ServiceConnection serviceConnection, Group group)
Parameters
Returns
Declaration
public static Task<DeserializedHttpResponse<Group>> PutToUpdateGroupForGroupAsync(this ServiceConnection serviceConnection, CancellationToken cancellationToken, Group group)
Parameters
Type |
Name |
Description |
ServiceConnection |
serviceConnection |
|
System.Threading.CancellationToken |
cancellationToken |
|
Group |
group |
|
Returns
ToRectangle(LineEntry)
Gets the bounding box from the specified entry.
Declaration
public static AnnotationRectangle ToRectangle(this LineEntry entry)
Parameters
Type |
Name |
Description |
LineEntry |
entry |
The entry.
|
Returns