Class WebResponseExtraction
- Namespace
- ArcanaDevelopment.adTempus.Shared.WebRequests
- Assembly
- ArcanaDevelopment.adTempus.Shared.dll
A rule that extracts a value from a Web Request Task response into a job variable.
[Serializable]
[DataContract(Name = "Extraction", Namespace = "")]
public sealed class WebResponseExtraction
- Inheritance
-
objectWebResponseExtraction
Constructors
WebResponseExtraction()
Initializes a new extraction rule.
public WebResponseExtraction()
WebResponseExtraction(string, WebResponseExtractionType, string)
Initializes a new extraction rule with the specified values.
public WebResponseExtraction(string variableName, WebResponseExtractionType expressionType, string expression)
Parameters
| Name | Type | Description |
|---|---|---|
variableName |
string | |
expressionType |
WebResponseExtractionType | |
expression |
string |
Properties
Expression
The JSONPath or XPath expression, or the header name, that locates the value.
[DataMember(Order = 2)]
[CanBeNull]
public string Expression { get; set; }
Property Value
- string
ExpressionType
The type of Expression.
[DataMember(Order = 1)]
public WebResponseExtractionType ExpressionType { get; set; }
Property Value
VariableName
The name of the job variable that receives the extracted value.
[DataMember(Order = 0)]
[CanBeNull]
public string VariableName { get; set; }
Property Value
- string
Methods
Clone()
Creates a copy of the rule.
public WebResponseExtraction Clone()
Returns
ToString()
Returns a string that represents the current object.
public override string ToString()
Returns
- string
A string that represents the current object.