Table of Contents

Class WebRequestTask

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Task that sends a request to w Web server

public sealed class WebRequestTask : Task
Inheritance
object
WebRequestTask

Properties

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

CredentialProfile

The credentials to use for this request.

public CredentialProfile CredentialProfile { get; set; }

Property Value

CredentialProfile

Remarks

Optional. If not specified, the job identity will be used.

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

MaxRunTime

The maximum execution time for the download. If the download exceeds the specified time it will be terminated.

public TimeSpan MaxRunTime { get; set; }

Property Value

TimeSpan

Remarks

Set to System.TimeSpan.Zero for no limit.

RequestBody

The body of the request to send to the server if the RequestMethod is POST.

public string RequestBody { get; set; }

Property Value

string

Remarks

If the RequestMethod is POST, the RequestBody specifies the HTTP request to send to the server.

RequestMethod

The HTTP method to use when sending the request.

public string RequestMethod { get; set; }

Property Value

string

Remarks

By default a GET is performed. Set the RequestMethod to POST and set the RequestBody to perform a POST instead.

RequestURL

The URL to request.

public string RequestURL { get; set; }

Property Value

string

Remarks

This value is required. Variable tokens can be used. The protocol (e.g., "http://") must be included.

SaveAsCapturedFile

Specifies whether the save the requested page or file as a Captured File in the job history.

public bool SaveAsCapturedFile { get; set; }

Property Value

bool

Remarks

Default: false

See Also

SaveToLocation

Specifies the file name to use to save the requested page or file.

public string SaveToLocation { get; set; }

Property Value

string

Remarks

If a file name is specified, the requested page or file is saved to it. If no SaveLocation is specified, the file is not saved.

Variable tokens can be used in the value.
See Also

SupportedResponseEvents

Gets a list of the events that are supported for Responses associated with this task.

public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

Methods

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members