Class Organization

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Definition for DocuWare organization.

public class Organization : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

Organization

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Organization()

Creates a new instance of this class

public Organization()

Properties

AdditionalInfo

public AdditionalOrganizationInfo AdditionalInfo { get; set; }

Property Value

Type	Description
AdditionalOrganizationInfo

Calendar

public Calendar Calendar { get; set; }

Property Value

Type	Description
Calendar

ConfigurationRights

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

[Hawk]
public List<ConfigurationRight> ConfigurationRights { get; set; }

Property Value

Type	Description
List<ConfigurationRight>

ControllerWorkflowsRelationLink

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

public string ControllerWorkflowsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

CreateGroupRelationLink

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

public string CreateGroupRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

Culture

public OrganizationCulture Culture { get; set; }

Property Value

Type	Description
OrganizationCulture

CustomProperties

public List<OrganizationProperty> CustomProperties { get; set; }

Property Value

Type	Description
List<OrganizationProperty>

DesignerWorkflowsRelationLink

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

public string DesignerWorkflowsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

DialogsRelationLink

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

public string DialogsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

[Numbat]
public ExtendedConfigurationRights ExtendedConfigurationRights { get; set; }

Property Value

Type	Description
ExtendedConfigurationRights

FilecabinetsRelationLink

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

public string FilecabinetsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

GroupsRelationLink

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

public string GroupsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

public string Guid { get; set; }

Property Value

Type	Description
string

Id

Identity of the organization

public string Id { get; set; }

Property Value

Type	Description
string

IsTwoStepVerificationEnabled

Flag whether Two-Step Verification is enabled

public bool IsTwoStepVerificationEnabled { get; set; }

Property Value

Type	Description
bool

IsTwoStepVerificationRequired

Flag whether Two-Step Verification is enforced for all users in the organization

public bool IsTwoStepVerificationRequired { get; set; }

Property Value

Type	Description
bool

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

LoginTokenRelationLink

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

public string LoginTokenRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

MultiColSelectListInfosRelationLink

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

public string MultiColSelectListInfosRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

public string Name { get; set; }

Property Value

Type	Description
string

RolesRelationLink

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

public string RolesRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

SelectListInfosRelationLink

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

public string SelectListInfosRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

SelfRelationLink

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

public string SelfRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

SubstitutionListsRelationLink

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

public string SubstitutionListsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

TrashBinRelationLink

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

public string TrashBinRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

UserInfoRelationLink

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

public string UserInfoRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

UsersRelationLink

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

public string UsersRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

WorkflowRequestsRelationLink

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

public string WorkflowRequestsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

WorkflowsRelationLink

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

public string WorkflowsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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”.

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.

public Task<DeserializedHttpResponse<DesignerWorkflows>> GetDesignerWorkflowsFromDesignerWorkflowsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<DesignerWorkflows>>	A task which runs the request.

Remarks

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

GetDesignerWorkflowsFromDesignerWorkflowsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DesignerWorkflows>> GetDesignerWorkflowsFromDesignerWorkflowsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromDialogsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<DialogInfos>>	A task which runs the request.

Remarks

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

GetDialogInfosFromDialogsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromDialogsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<FileCabinets>> GetFileCabinetsFromFilecabinetsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<FileCabinets>>	A task which runs the request.

Remarks

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

GetFileCabinetsFromFilecabinetsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<FileCabinets>> GetFileCabinetsFromFilecabinetsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Groups>>	A task which runs the request.

Remarks

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

GetGroupsFromGroupsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<MultiColSelectListInfos>> GetMultiColSelectListInfosFromMultiColSelectListInfosRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<MultiColSelectListInfos>>	A task which runs the request.

Remarks

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

GetMultiColSelectListInfosFromMultiColSelectListInfosRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<MultiColSelectListInfos>> GetMultiColSelectListInfosFromMultiColSelectListInfosRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<Organization>> GetOrganizationFromSelfRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Organization>>	A task which runs the request.

Remarks

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

GetOrganizationFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Organization>> GetOrganizationFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Roles>>	A task which runs the request.

Remarks

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

GetRolesFromRolesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<SelectListInfos>> GetSelectListInfosFromSelectListInfosRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<SelectListInfos>>	A task which runs the request.

Remarks

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

GetSelectListInfosFromSelectListInfosRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<SelectListInfos>> GetSelectListInfosFromSelectListInfosRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<SubstitutionLists>> GetSubstitutionListsFromSubstitutionListsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<SubstitutionLists>>	A task which runs the request.

Remarks

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

GetSubstitutionListsFromSubstitutionListsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<SubstitutionLists>> GetSubstitutionListsFromSubstitutionListsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<TrashBin>> GetTrashBinFromTrashBinRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<TrashBin>>	A task which runs the request.

Remarks

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

GetTrashBinFromTrashBinRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<TrashBin>> GetTrashBinFromTrashBinRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<UserInfo>> GetUserInfoFromUserInfoRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<UserInfo>>	A task which runs the request.

Remarks

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

GetUserInfoFromUserInfoRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<UserInfo>> GetUserInfoFromUserInfoRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<Users>> GetUsersFromUsersRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Users>>	A task which runs the request.

Remarks

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

GetUsersFromUsersRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Users>> GetUsersFromUsersRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<WorkflowRequests>> GetWorkflowRequestsFromWorkflowRequestsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<WorkflowRequests>>	A task which runs the request.

Remarks

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

GetWorkflowRequestsFromWorkflowRequestsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<WorkflowRequests>> GetWorkflowRequestsFromWorkflowRequestsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromControllerWorkflowsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Workflows>>	A task which runs the request.

Remarks

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

GetWorkflowsFromControllerWorkflowsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromControllerWorkflowsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromWorkflowsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Workflows>>	A task which runs the request.

Remarks

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

GetWorkflowsFromWorkflowsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromWorkflowsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
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”.

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.

public 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
Task<DeserializedHttpResponse<Group>>	A task which runs the request.

Remarks

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

PostToCreateGroupRelationForGroupAsync(CancellationToken, Group)

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

public Task<DeserializedHttpResponse<Group>> PostToCreateGroupRelationForGroupAsync(CancellationToken cancellationToken, Group dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<Group>>	A task which runs the request.

Remarks

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

PostToDesignerWorkflowsRelationForDesignerWorkflows(DesignerWorkflowsQuery)

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

public DesignerWorkflows PostToDesignerWorkflowsRelationForDesignerWorkflows(DesignerWorkflowsQuery dataToSend)

Parameters

Type	Name	Description
DesignerWorkflowsQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
DesignerWorkflows	The content of the response.

PostToDesignerWorkflowsRelationForDesignerWorkflowsAsync(DesignerWorkflowsQuery)

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

public Task<DeserializedHttpResponse<DesignerWorkflows>> PostToDesignerWorkflowsRelationForDesignerWorkflowsAsync(DesignerWorkflowsQuery dataToSend)

Parameters

Type	Name	Description
DesignerWorkflowsQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
Task<DeserializedHttpResponse<DesignerWorkflows>>	A task which runs the request.

Remarks

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

PostToDesignerWorkflowsRelationForDesignerWorkflowsAsync(CancellationToken, DesignerWorkflowsQuery)

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

public Task<DeserializedHttpResponse<DesignerWorkflows>> PostToDesignerWorkflowsRelationForDesignerWorkflowsAsync(CancellationToken cancellationToken, DesignerWorkflowsQuery dataToSend)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.
DesignerWorkflowsQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
Task<DeserializedHttpResponse<DesignerWorkflows>>	A task which runs the request.

Remarks

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

PostToDialogsRelationForDialogInfos(RequestDialogQuery)

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

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.

public 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
Task<DeserializedHttpResponse<DialogInfos>>	A task which runs the request.

Remarks

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

PostToDialogsRelationForDialogInfosAsync(CancellationToken, RequestDialogQuery)

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

public Task<DeserializedHttpResponse<DialogInfos>> PostToDialogsRelationForDialogInfosAsync(CancellationToken cancellationToken, RequestDialogQuery dataToSend)

Parameters

Type	Name	Description
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
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”.

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.

public 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
Task<DeserializedHttpResponse<Groups>>	A task which runs the request.

Remarks

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

PostToGroupsRelationForGroupsAsync(CancellationToken, GroupsQuery)

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

public Task<DeserializedHttpResponse<Groups>> PostToGroupsRelationForGroupsAsync(CancellationToken cancellationToken, GroupsQuery dataToSend)

Parameters

Type	Name	Description
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
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”.

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
string	The content of the response.

PostToLoginTokenRelationForStringAsync(TokenDescription)

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

public 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
Task<DeserializedHttpResponse<string>>	A task which runs the request.

Remarks

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

PostToLoginTokenRelationForStringAsync(CancellationToken, TokenDescription)

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

public Task<DeserializedHttpResponse<string>> PostToLoginTokenRelationForStringAsync(CancellationToken cancellationToken, TokenDescription dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<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”.

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.

public 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
Task<DeserializedHttpResponse<Roles>>	A task which runs the request.

Remarks

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

PostToRolesRelationForRolesAsync(CancellationToken, RolesQuery)

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

public Task<DeserializedHttpResponse<Roles>> PostToRolesRelationForRolesAsync(CancellationToken cancellationToken, RolesQuery dataToSend)

Parameters

Type	Name	Description
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
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”.

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”.

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.

public 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
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.

public 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
Task<DeserializedHttpResponse<User>>	A task which runs the request.

Remarks

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

PostToUserInfoRelationForUserAsync(CancellationToken, NewUser)

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

public Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(CancellationToken cancellationToken, NewUser dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<User>>	A task which runs the request.

Remarks

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

PostToUserInfoRelationForUserAsync(CancellationToken, User)

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

public Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(CancellationToken cancellationToken, User dataToSend)

Parameters

Type	Name	Description
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
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”.

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.

public 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
Task<DeserializedHttpResponse<Groups>>	A task which runs the request.

Remarks

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

PostToUsersRelationForGroupsAsync(CancellationToken, UserGroupsQuery)

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

public Task<DeserializedHttpResponse<Groups>> PostToUsersRelationForGroupsAsync(CancellationToken cancellationToken, UserGroupsQuery dataToSend)

Parameters

Type	Name	Description
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
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”.

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.

public 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
Task<DeserializedHttpResponse<Roles>>	A task which runs the request.

Remarks

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

PostToUsersRelationForRolesAsync(CancellationToken, UserRolesQuery)

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

public Task<DeserializedHttpResponse<Roles>> PostToUsersRelationForRolesAsync(CancellationToken cancellationToken, UserRolesQuery dataToSend)

Parameters

Type	Name	Description
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
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”.

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”.

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.

public 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
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.

public 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
Task<DeserializedHttpResponse<Users>>	A task which runs the request.

Remarks

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

PostToUsersRelationForUsersAsync(CancellationToken, UsersByRole)

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

public Task<DeserializedHttpResponse<Users>> PostToUsersRelationForUsersAsync(CancellationToken cancellationToken, UsersByRole dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<Users>>	A task which runs the request.

Remarks

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

PostToUsersRelationForUsersAsync(CancellationToken, UsersQuery)

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

public Task<DeserializedHttpResponse<Users>> PostToUsersRelationForUsersAsync(CancellationToken cancellationToken, UsersQuery dataToSend)

Parameters

Type	Name	Description
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
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”.

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
string	The content of the response.

PostToWorkflowRequestsRelationForStringAsync(RequestSettings)

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

public 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
Task<DeserializedHttpResponse<string>>	A task which runs the request.

Remarks

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

PostToWorkflowRequestsRelationForStringAsync(CancellationToken, RequestSettings)

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

public Task<DeserializedHttpResponse<string>> PostToWorkflowRequestsRelationForStringAsync(CancellationToken cancellationToken, RequestSettings dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<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.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The HttpClient 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.