Class RestRequestStringBuilder

A class that is capable of build REST request.

Inheritance

System.Object

RestRequestStringBuilder

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TimeCockpit.Data.RequestHelper

Assembly: TimeCockpit.Data.dll

Syntax

public class RestRequestStringBuilder

Constructors

RestRequestStringBuilder(String)

Initializes a new instance of the RestRequestStringBuilder class.

Declaration

public RestRequestStringBuilder(string serviceUrl)

Parameters

Type	Name	Description
System.String	serviceUrl	The service URL.

Properties

ExecuteActionUriTemplate

Gets the execute action URI template.

Declaration

public string ExecuteActionUriTemplate { get; }

Property Value

Type	Description
System.String

ModelUriTemplate

Gets the model URI template.

Declaration

public string ModelUriTemplate { get; }

Property Value

Type	Description
System.String

SaveChangesUriTemplate

Gets the save changes URI template.

Declaration

public string SaveChangesUriTemplate { get; }

Property Value

Type	Description
System.String

ServiceUrl

Gets the service URL.

Declaration

public string ServiceUrl { get; }

Property Value

Type	Description
System.String

Methods

CreateCurrentUserRequestUri()

Creates the template for fetching the current user

Declaration

public string CreateCurrentUserRequestUri()

Returns

Type	Description
System.String	returns a uri request string for fetching the curren datacontext user.

CreateEntitiesBaseRequestUri()

creates the template for saving an entity object

Declaration

public string CreateEntitiesBaseRequestUri()

Returns

Type	Description
System.String	returns a uri request string for saving an object.

CreateExecuteActionAsyncRequestUri(Boolean)

Creates the execute action async request URI.

Declaration

public string CreateExecuteActionAsyncRequestUri(bool compress)

Parameters

Type	Name	Description
System.Boolean	compress	True if compression should be used, false otherwise.

Returns

Type	Description
System.String	returns the request uri for executeaction

CreatePostSelectByListNameAsyncRequestUri(Boolean)

creates the request uri for a SelectByListname.

Declaration

public string CreatePostSelectByListNameAsyncRequestUri(bool compress)

Parameters

Type	Name	Description
System.Boolean	compress	true if compression should be used, false otherwise.

Returns

Type	Description
System.String	returns the uri request string.

CreatePostSelectTopAsyncRequestUri(Boolean)

creates the request uri for a select top with params.

Declaration

public string CreatePostSelectTopAsyncRequestUri(bool compress)

Parameters

Type	Name	Description
System.Boolean	compress	true if compression should be used, false otherwise.

Returns

Type	Description
System.String	returns the uri request string.

CreateRefreshEnvironmentRequestUri()

Creates the uri for refresh an environment.

Declaration

public string CreateRefreshEnvironmentRequestUri()

Returns

Type	Description
System.String	returns the uri to refresh the environment.

CreateRefreshNamedSetRequestUri(String)

Creates the uri for refreshing a namedset

Declaration

public string CreateRefreshNamedSetRequestUri(string name)

Parameters

Type	Name	Description
System.String	name	The name of the set to refresh.

Returns

Type	Description
System.String	Returns a uri request string for refreshing a named set.

CreateSaveChangesAsyncRequestUri()

Creates a request uri for a save changes async method.

Declaration

public string CreateSaveChangesAsyncRequestUri()

Returns

Type	Description
System.String	returns the request uri

CreateSelectSingleAsyncRequestUri(IEntityObject, Boolean, Boolean)

Creates a uri request string for a select single for a given entity object proxy descriptor

Declaration

public string CreateSelectSingleAsyncRequestUri(IEntityObject entityObject, bool autoIncludeRelations, bool compress)

Parameters

Type	Name	Description
IEntityObject	entityObject	entity object proxy descriptor
System.Boolean	autoIncludeRelations	true if relations should be included, false otherwise
System.Boolean	compress	True if compression should be used, False otherwise.

Returns

Type	Description
System.String	returns the request uri.

CreateSignDownloadTokenRequestUri()

Creates the uri for signing a download token.

Declaration

public string CreateSignDownloadTokenRequestUri()

Returns

Type	Description
System.String	returns the uri to sign a download token.