Class Organization

Definition for DocuWare organization.

Inheritance
System.Object
Organization
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class Organization : IRelationsWithProxy

Properties

AdditionalInfo

Declaration
public AdditionalOrganizationInfo AdditionalInfo { get; set; }
Property Value
Type Description
AdditionalOrganizationInfo

Calendar

Declaration
public Calendar Calendar { get; set; }
Property Value
Type Description
Calendar

ConfigurationRights

List of the rights that the current user has for this cabinet.

Declaration
public List<ConfigurationRight> ConfigurationRights { get; set; }
Property Value
Type Description
List<ConfigurationRight>

Gets the Uri of the link for the relation “controllerWorkflows”.

Declaration
public string ControllerWorkflowsRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “controllerWorkflows” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “createGroup”.

Declaration
public string CreateGroupRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “createGroup” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “designerWorkflows”.

Declaration
public string DesignerWorkflowsRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “designerWorkflows” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “dialogs”.

Declaration
public string DialogsRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “dialogs” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

ExtendedConfigurationRights

Gets or sets the extended configuration rights

Declaration
public ExtendedConfigurationRights ExtendedConfigurationRights { get; set; }
Property Value
Type Description
ExtendedConfigurationRights

Gets the Uri of the link for the relation “filecabinets”.

Declaration
public string FilecabinetsRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “filecabinets” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “groups”.

Declaration
public string GroupsRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “groups” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Guid

Guid of the organization

Declaration
public string Guid { get; set; }
Property Value
Type Description
System.String

Id

Identity of the organization

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String
Declaration
public Link[] Links { get; set; }
Property Value
Type Description
Link[]

Gets the Uri of the link for the relation “loginToken”.

Declaration
public string LoginTokenRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “loginToken” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “multiColSelectListInfos”.

Declaration
public string MultiColSelectListInfosRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “multiColSelectListInfos” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Name

Name of the organization

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Gets the Uri of the link for the relation “roles”.

Declaration
public string RolesRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “roles” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “selectListInfos”.

Declaration
public string SelectListInfosRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “selectListInfos” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “self”.

Declaration
public string SelfRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “self” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “substitutionLists”.

Declaration
public string SubstitutionListsRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “substitutionLists” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “trashBin”.

Declaration
public string TrashBinRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “trashBin” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “userInfo”.

Declaration
public string UserInfoRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “userInfo” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “users”.

Declaration
public string UsersRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “users” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “workflowRequests”.

Declaration
public string WorkflowRequestsRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “workflowRequests” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Gets the Uri of the link for the relation “workflows”.

Declaration
public string WorkflowsRelationLink { get; }
Property Value
Type Description
System.String

Returns the uri of the link for the relation “workflows” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Methods

GetDesignerWorkflowsFromDesignerWorkflowsRelation()

Calls the HTTP Get method on the link for the relation “designerWorkflows”.

Declaration
public DesignerWorkflows GetDesignerWorkflowsFromDesignerWorkflowsRelation()
Returns
Type Description
DesignerWorkflows

The content of the response.

GetDesignerWorkflowsFromDesignerWorkflowsRelationAsync()

Calls the HTTP Get method on the link for the relation “designerWorkflows” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DesignerWorkflows>> GetDesignerWorkflowsFromDesignerWorkflowsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DesignerWorkflows>>

A task which runs the request.
Remarks

This method follows the link for the relation “designerWorkflows”.

GetDesignerWorkflowsFromDesignerWorkflowsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “designerWorkflows” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DesignerWorkflows>> GetDesignerWorkflowsFromDesignerWorkflowsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DesignerWorkflows>>

A task which runs the request.
Remarks

This method follows the link for the relation “designerWorkflows”.

GetDialogInfosFromDialogsRelation()

Calls the HTTP Get method on the link for the relation “dialogs”.

Declaration
public DialogInfos GetDialogInfosFromDialogsRelation()
Returns
Type Description
DialogInfos

The content of the response.

GetDialogInfosFromDialogsRelationAsync()

Calls the HTTP Get method on the link for the relation “dialogs” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromDialogsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

This method follows the link for the relation “dialogs”.

GetDialogInfosFromDialogsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “dialogs” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromDialogsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

This method follows the link for the relation “dialogs”.

GetFileCabinetsFromFilecabinetsRelation()

Calls the HTTP Get method on the link for the relation “filecabinets”.

Declaration
public FileCabinets GetFileCabinetsFromFilecabinetsRelation()
Returns
Type Description
FileCabinets

The content of the response.

GetFileCabinetsFromFilecabinetsRelationAsync()

Calls the HTTP Get method on the link for the relation “filecabinets” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinets>> GetFileCabinetsFromFilecabinetsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinets>>

A task which runs the request.
Remarks

This method follows the link for the relation “filecabinets”.

GetFileCabinetsFromFilecabinetsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “filecabinets” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinets>> GetFileCabinetsFromFilecabinetsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinets>>

A task which runs the request.
Remarks

This method follows the link for the relation “filecabinets”.

GetGroupsFromGroupsRelation()

Calls the HTTP Get method on the link for the relation “groups”.

Declaration
public Groups GetGroupsFromGroupsRelation()
Returns
Type Description
Groups

The content of the response.

GetGroupsFromGroupsRelationAsync()

Calls the HTTP Get method on the link for the relation “groups” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>>

A task which runs the request.
Remarks

This method follows the link for the relation “groups”.

GetGroupsFromGroupsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “groups” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>>

A task which runs the request.
Remarks

This method follows the link for the relation “groups”.

GetMultiColSelectListInfosFromMultiColSelectListInfosRelation()

Calls the HTTP Get method on the link for the relation “multiColSelectListInfos”.

Declaration
public MultiColSelectListInfos GetMultiColSelectListInfosFromMultiColSelectListInfosRelation()
Returns
Type Description
MultiColSelectListInfos

The content of the response.

GetMultiColSelectListInfosFromMultiColSelectListInfosRelationAsync()

Calls the HTTP Get method on the link for the relation “multiColSelectListInfos” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListInfos>> GetMultiColSelectListInfosFromMultiColSelectListInfosRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListInfos>>

A task which runs the request.
Remarks

This method follows the link for the relation “multiColSelectListInfos”.

GetMultiColSelectListInfosFromMultiColSelectListInfosRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “multiColSelectListInfos” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListInfos>> GetMultiColSelectListInfosFromMultiColSelectListInfosRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListInfos>>

A task which runs the request.
Remarks

This method follows the link for the relation “multiColSelectListInfos”.

GetOrganizationFromSelfRelation()

Calls the HTTP Get method on the link for the relation “self”.

Declaration
public Organization GetOrganizationFromSelfRelation()
Returns
Type Description
Organization

The content of the response.

GetOrganizationFromSelfRelationAsync()

Calls the HTTP Get method on the link for the relation “self” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Organization>> GetOrganizationFromSelfRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Organization>>

A task which runs the request.
Remarks

This method follows the link for the relation “self”.

GetOrganizationFromSelfRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “self” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Organization>> GetOrganizationFromSelfRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Organization>>

A task which runs the request.
Remarks

This method follows the link for the relation “self”.

GetRolesFromRolesRelation()

Calls the HTTP Get method on the link for the relation “roles”.

Declaration
public Roles GetRolesFromRolesRelation()
Returns
Type Description
Roles

The content of the response.

GetRolesFromRolesRelationAsync()

Calls the HTTP Get method on the link for the relation “roles” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>>

A task which runs the request.
Remarks

This method follows the link for the relation “roles”.

GetRolesFromRolesRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “roles” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>>

A task which runs the request.
Remarks

This method follows the link for the relation “roles”.

GetSelectListInfosFromSelectListInfosRelation()

Calls the HTTP Get method on the link for the relation “selectListInfos”.

Declaration
public SelectListInfos GetSelectListInfosFromSelectListInfosRelation()
Returns
Type Description
SelectListInfos

The content of the response.

GetSelectListInfosFromSelectListInfosRelationAsync()

Calls the HTTP Get method on the link for the relation “selectListInfos” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListInfos>> GetSelectListInfosFromSelectListInfosRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListInfos>>

A task which runs the request.
Remarks

This method follows the link for the relation “selectListInfos”.

GetSelectListInfosFromSelectListInfosRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “selectListInfos” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListInfos>> GetSelectListInfosFromSelectListInfosRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListInfos>>

A task which runs the request.
Remarks

This method follows the link for the relation “selectListInfos”.

GetSubstitutionListsFromSubstitutionListsRelation()

Calls the HTTP Get method on the link for the relation “substitutionLists”.

Declaration
public SubstitutionLists GetSubstitutionListsFromSubstitutionListsRelation()
Returns
Type Description
SubstitutionLists

The content of the response.

GetSubstitutionListsFromSubstitutionListsRelationAsync()

Calls the HTTP Get method on the link for the relation “substitutionLists” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionLists>> GetSubstitutionListsFromSubstitutionListsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionLists>>

A task which runs the request.
Remarks

This method follows the link for the relation “substitutionLists”.

GetSubstitutionListsFromSubstitutionListsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “substitutionLists” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionLists>> GetSubstitutionListsFromSubstitutionListsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionLists>>

A task which runs the request.
Remarks

This method follows the link for the relation “substitutionLists”.

GetTrashBinFromTrashBinRelation()

Calls the HTTP Get method on the link for the relation “trashBin”.

Declaration
public TrashBin GetTrashBinFromTrashBinRelation()
Returns
Type Description
TrashBin

The content of the response.

GetTrashBinFromTrashBinRelationAsync()

Calls the HTTP Get method on the link for the relation “trashBin” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBin>> GetTrashBinFromTrashBinRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBin>>

A task which runs the request.
Remarks

This method follows the link for the relation “trashBin”.

GetTrashBinFromTrashBinRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “trashBin” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBin>> GetTrashBinFromTrashBinRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBin>>

A task which runs the request.
Remarks

This method follows the link for the relation “trashBin”.

GetUserInfoFromUserInfoRelation()

Calls the HTTP Get method on the link for the relation “userInfo”.

Declaration
public UserInfo GetUserInfoFromUserInfoRelation()
Returns
Type Description
UserInfo

The content of the response.

GetUserInfoFromUserInfoRelationAsync()

Calls the HTTP Get method on the link for the relation “userInfo” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<UserInfo>> GetUserInfoFromUserInfoRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<UserInfo>>

A task which runs the request.
Remarks

This method follows the link for the relation “userInfo”.

GetUserInfoFromUserInfoRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “userInfo” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<UserInfo>> GetUserInfoFromUserInfoRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<UserInfo>>

A task which runs the request.
Remarks

This method follows the link for the relation “userInfo”.

GetUsersFromUsersRelation()

Calls the HTTP Get method on the link for the relation “users”.

Declaration
public Users GetUsersFromUsersRelation()
Returns
Type Description
Users

The content of the response.

GetUsersFromUsersRelationAsync()

Calls the HTTP Get method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> GetUsersFromUsersRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Users>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

GetUsersFromUsersRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> GetUsersFromUsersRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Users>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

GetWorkflowRequestsFromWorkflowRequestsRelation()

Calls the HTTP Get method on the link for the relation “workflowRequests”.

Declaration
public WorkflowRequests GetWorkflowRequestsFromWorkflowRequestsRelation()
Returns
Type Description
WorkflowRequests

The content of the response.

GetWorkflowRequestsFromWorkflowRequestsRelationAsync()

Calls the HTTP Get method on the link for the relation “workflowRequests” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowRequests>> GetWorkflowRequestsFromWorkflowRequestsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowRequests>>

A task which runs the request.
Remarks

This method follows the link for the relation “workflowRequests”.

GetWorkflowRequestsFromWorkflowRequestsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “workflowRequests” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowRequests>> GetWorkflowRequestsFromWorkflowRequestsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowRequests>>

A task which runs the request.
Remarks

This method follows the link for the relation “workflowRequests”.

GetWorkflowsFromControllerWorkflowsRelation()

Calls the HTTP Get method on the link for the relation “controllerWorkflows”.

Declaration
public Workflows GetWorkflowsFromControllerWorkflowsRelation()
Returns
Type Description
Workflows

The content of the response.

GetWorkflowsFromControllerWorkflowsRelationAsync()

Calls the HTTP Get method on the link for the relation “controllerWorkflows” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromControllerWorkflowsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>>

A task which runs the request.
Remarks

This method follows the link for the relation “controllerWorkflows”.

GetWorkflowsFromControllerWorkflowsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “controllerWorkflows” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromControllerWorkflowsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>>

A task which runs the request.
Remarks

This method follows the link for the relation “controllerWorkflows”.

GetWorkflowsFromWorkflowsRelation()

Calls the HTTP Get method on the link for the relation “workflows”.

Declaration
public Workflows GetWorkflowsFromWorkflowsRelation()
Returns
Type Description
Workflows

The content of the response.

GetWorkflowsFromWorkflowsRelationAsync()

Calls the HTTP Get method on the link for the relation “workflows” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromWorkflowsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>>

A task which runs the request.
Remarks

This method follows the link for the relation “workflows”.

GetWorkflowsFromWorkflowsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “workflows” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromWorkflowsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>>

A task which runs the request.
Remarks

This method follows the link for the relation “workflows”.

PostToCreateGroupRelationForGroup(Group)

Calls the HTTP Post method on the link for the relation “createGroup”.

Declaration
public Group PostToCreateGroupRelationForGroup(Group dataToSend)
Parameters
Type Name Description
Group dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
Group

The content of the response.

PostToCreateGroupRelationForGroupAsync(Group)

Calls the HTTP Post method on the link for the relation “createGroup” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Group>> PostToCreateGroupRelationForGroupAsync(Group dataToSend)
Parameters
Type Name Description
Group dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Group>>

A task which runs the request.
Remarks

This method follows the link for the relation “createGroup”.

PostToCreateGroupRelationForGroupAsync(System.Threading.CancellationToken, Group)

Calls the HTTP Post method on the link for the relation “createGroup” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Group>> PostToCreateGroupRelationForGroupAsync(System.Threading.CancellationToken cancellationToken, Group dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Group dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Group>>

A task which runs the request.
Remarks

This method follows the link for the relation “createGroup”.

PostToDialogsRelationForDialogInfos(RequestDialogQuery)

Calls the HTTP Post method on the link for the relation “dialogs”.

Declaration
public DialogInfos PostToDialogsRelationForDialogInfos(RequestDialogQuery dataToSend)
Parameters
Type Name Description
RequestDialogQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
DialogInfos

The content of the response.

PostToDialogsRelationForDialogInfosAsync(RequestDialogQuery)

Calls the HTTP Post method on the link for the relation “dialogs” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> PostToDialogsRelationForDialogInfosAsync(RequestDialogQuery dataToSend)
Parameters
Type Name Description
RequestDialogQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

This method follows the link for the relation “dialogs”.

PostToDialogsRelationForDialogInfosAsync(System.Threading.CancellationToken, RequestDialogQuery)

Calls the HTTP Post method on the link for the relation “dialogs” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> PostToDialogsRelationForDialogInfosAsync(System.Threading.CancellationToken cancellationToken, RequestDialogQuery dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
RequestDialogQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

This method follows the link for the relation “dialogs”.

PostToGroupsRelationForGroups(GroupsQuery)

Calls the HTTP Post method on the link for the relation “groups”.

Declaration
public Groups PostToGroupsRelationForGroups(GroupsQuery dataToSend)
Parameters
Type Name Description
GroupsQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
Groups

The content of the response.

PostToGroupsRelationForGroupsAsync(GroupsQuery)

Calls the HTTP Post method on the link for the relation “groups” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>> PostToGroupsRelationForGroupsAsync(GroupsQuery dataToSend)
Parameters
Type Name Description
GroupsQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>>

A task which runs the request.
Remarks

This method follows the link for the relation “groups”.

PostToGroupsRelationForGroupsAsync(System.Threading.CancellationToken, GroupsQuery)

Calls the HTTP Post method on the link for the relation “groups” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>> PostToGroupsRelationForGroupsAsync(System.Threading.CancellationToken cancellationToken, GroupsQuery dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
GroupsQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>>

A task which runs the request.
Remarks

This method follows the link for the relation “groups”.

PostToLoginTokenRelationForString(TokenDescription)

Calls the HTTP Post method on the link for the relation “loginToken”.

Declaration
public string PostToLoginTokenRelationForString(TokenDescription dataToSend)
Parameters
Type Name Description
TokenDescription dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.String

The content of the response.

PostToLoginTokenRelationForStringAsync(TokenDescription)

Calls the HTTP Post method on the link for the relation “loginToken” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLoginTokenRelationForStringAsync(TokenDescription dataToSend)
Parameters
Type Name Description
TokenDescription dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>

A task which runs the request.
Remarks

This method follows the link for the relation “loginToken”.

PostToLoginTokenRelationForStringAsync(System.Threading.CancellationToken, TokenDescription)

Calls the HTTP Post method on the link for the relation “loginToken” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLoginTokenRelationForStringAsync(System.Threading.CancellationToken cancellationToken, TokenDescription dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
TokenDescription dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>

A task which runs the request.
Remarks

This method follows the link for the relation “loginToken”.

PostToRolesRelationForRoles(RolesQuery)

Calls the HTTP Post method on the link for the relation “roles”.

Declaration
public Roles PostToRolesRelationForRoles(RolesQuery dataToSend)
Parameters
Type Name Description
RolesQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
Roles

The content of the response.

PostToRolesRelationForRolesAsync(RolesQuery)

Calls the HTTP Post method on the link for the relation “roles” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>> PostToRolesRelationForRolesAsync(RolesQuery dataToSend)
Parameters
Type Name Description
RolesQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>>

A task which runs the request.
Remarks

This method follows the link for the relation “roles”.

PostToRolesRelationForRolesAsync(System.Threading.CancellationToken, RolesQuery)

Calls the HTTP Post method on the link for the relation “roles” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>> PostToRolesRelationForRolesAsync(System.Threading.CancellationToken cancellationToken, RolesQuery dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
RolesQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>>

A task which runs the request.
Remarks

This method follows the link for the relation “roles”.

PostToUserInfoRelationForUser(NewUser)

Calls the HTTP Post method on the link for the relation “userInfo”.

Declaration
public User PostToUserInfoRelationForUser(NewUser dataToSend)
Parameters
Type Name Description
NewUser dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
User

The content of the response.

PostToUserInfoRelationForUser(User)

Calls the HTTP Post method on the link for the relation “userInfo”.

Declaration
public User PostToUserInfoRelationForUser(User dataToSend)
Parameters
Type Name Description
User dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
User

The content of the response.

PostToUserInfoRelationForUserAsync(NewUser)

Calls the HTTP Post method on the link for the relation “userInfo” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(NewUser dataToSend)
Parameters
Type Name Description
NewUser dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<User>>

A task which runs the request.
Remarks

This method follows the link for the relation “userInfo”.

PostToUserInfoRelationForUserAsync(User)

Calls the HTTP Post method on the link for the relation “userInfo” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(User dataToSend)
Parameters
Type Name Description
User dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<User>>

A task which runs the request.
Remarks

This method follows the link for the relation “userInfo”.

PostToUserInfoRelationForUserAsync(System.Threading.CancellationToken, NewUser)

Calls the HTTP Post method on the link for the relation “userInfo” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(System.Threading.CancellationToken cancellationToken, NewUser dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
NewUser dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<User>>

A task which runs the request.
Remarks

This method follows the link for the relation “userInfo”.

PostToUserInfoRelationForUserAsync(System.Threading.CancellationToken, User)

Calls the HTTP Post method on the link for the relation “userInfo” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(System.Threading.CancellationToken cancellationToken, User dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
User dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<User>>

A task which runs the request.
Remarks

This method follows the link for the relation “userInfo”.

PostToUsersRelationForGroups(UserGroupsQuery)

Calls the HTTP Post method on the link for the relation “users”.

Declaration
public Groups PostToUsersRelationForGroups(UserGroupsQuery dataToSend)
Parameters
Type Name Description
UserGroupsQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
Groups

The content of the response.

PostToUsersRelationForGroupsAsync(UserGroupsQuery)

Calls the HTTP Post method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>> PostToUsersRelationForGroupsAsync(UserGroupsQuery dataToSend)
Parameters
Type Name Description
UserGroupsQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

PostToUsersRelationForGroupsAsync(System.Threading.CancellationToken, UserGroupsQuery)

Calls the HTTP Post method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>> PostToUsersRelationForGroupsAsync(System.Threading.CancellationToken cancellationToken, UserGroupsQuery dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
UserGroupsQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

PostToUsersRelationForRoles(UserRolesQuery)

Calls the HTTP Post method on the link for the relation “users”.

Declaration
public Roles PostToUsersRelationForRoles(UserRolesQuery dataToSend)
Parameters
Type Name Description
UserRolesQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
Roles

The content of the response.

PostToUsersRelationForRolesAsync(UserRolesQuery)

Calls the HTTP Post method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>> PostToUsersRelationForRolesAsync(UserRolesQuery dataToSend)
Parameters
Type Name Description
UserRolesQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

PostToUsersRelationForRolesAsync(System.Threading.CancellationToken, UserRolesQuery)

Calls the HTTP Post method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>> PostToUsersRelationForRolesAsync(System.Threading.CancellationToken cancellationToken, UserRolesQuery dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
UserRolesQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

PostToUsersRelationForUsers(UsersByRole)

Calls the HTTP Post method on the link for the relation “users”.

Declaration
public Users PostToUsersRelationForUsers(UsersByRole dataToSend)
Parameters
Type Name Description
UsersByRole dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
Users

The content of the response.

PostToUsersRelationForUsers(UsersQuery)

Calls the HTTP Post method on the link for the relation “users”.

Declaration
public Users PostToUsersRelationForUsers(UsersQuery dataToSend)
Parameters
Type Name Description
UsersQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
Users

The content of the response.

PostToUsersRelationForUsersAsync(UsersByRole)

Calls the HTTP Post method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> PostToUsersRelationForUsersAsync(UsersByRole dataToSend)
Parameters
Type Name Description
UsersByRole dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Users>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

PostToUsersRelationForUsersAsync(UsersQuery)

Calls the HTTP Post method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> PostToUsersRelationForUsersAsync(UsersQuery dataToSend)
Parameters
Type Name Description
UsersQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Users>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

PostToUsersRelationForUsersAsync(System.Threading.CancellationToken, UsersByRole)

Calls the HTTP Post method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> PostToUsersRelationForUsersAsync(System.Threading.CancellationToken cancellationToken, UsersByRole dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
UsersByRole dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Users>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

PostToUsersRelationForUsersAsync(System.Threading.CancellationToken, UsersQuery)

Calls the HTTP Post method on the link for the relation “users” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> PostToUsersRelationForUsersAsync(System.Threading.CancellationToken cancellationToken, UsersQuery dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
UsersQuery dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Users>>

A task which runs the request.
Remarks

This method follows the link for the relation “users”.

PostToWorkflowRequestsRelationForString(RequestSettings)

Calls the HTTP Post method on the link for the relation “workflowRequests”.

Declaration
public string PostToWorkflowRequestsRelationForString(RequestSettings dataToSend)
Parameters
Type Name Description
RequestSettings dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.String

The content of the response.

PostToWorkflowRequestsRelationForStringAsync(RequestSettings)

Calls the HTTP Post method on the link for the relation “workflowRequests” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToWorkflowRequestsRelationForStringAsync(RequestSettings dataToSend)
Parameters
Type Name Description
RequestSettings dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>

A task which runs the request.
Remarks

This method follows the link for the relation “workflowRequests”.

PostToWorkflowRequestsRelationForStringAsync(System.Threading.CancellationToken, RequestSettings)

Calls the HTTP Post method on the link for the relation “workflowRequests” asynchronously.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToWorkflowRequestsRelationForStringAsync(System.Threading.CancellationToken cancellationToken, RequestSettings dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
RequestSettings dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>

A task which runs the request.
Remarks

This method follows the link for the relation “workflowRequests”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

Declaration
public void SetProxy(HttpClientProxy proxy)
Parameters
Type Name Description
HttpClientProxy proxy

The instance which is used in further HTTP communication.
Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.