Touchstone 11.0 API Reference
GetFileRequest Class Properties


Air.Services.Proxy Assembly > AIR.Services.ActivityManagement.Api Namespace : GetFileRequest Class

For a list of all members of this type, see GetFileRequest members.

Public Properties
 NameDescription
Public Property(Required) Contains the SID of the Activity for which you want to retrieve the path to the associated log file. You can find the Activity SID by looking at the response returned by asynchronous web service calls, such as the Touchstone® SubmitCreateDatabase() method.  
Public Property(Required) Contains the Business Unit Sequential Identifier (SID), which is a Touchstone®-generated integer that uniquely identifies a Business Unit.

The Business Unit SID is an integer Sequential Identifier that the Touchstone application generates to identify a Business Unit uniquely. A Business Unit is a department, division, local office, or some other sub-group of an organization. You can define it any way you wish. The API analyzes data from a single Business Unit at a time.

(Inherited from AIR.Services.Common.Api.RequestBase)
Public Property(Required) Contains the SQL Server Instance Sequential Identifier (SID), which is a Touchstone®-generated integer that uniquely identifies the SQL Server Instance that hosts the associated Data Source.

The SQL Instance SID is an integer Sequential Identifier that Touchstone generates to identify uniquely the SQL instance that hosts the Data Source used for the analysis. A Data Source is an Exposure or Results database that is registered with the Touchstone application.

(Inherited from AIR.Services.Common.Api.RequestBase)
Public Property(Required) Contains the name of the template file that contains the log for the specified Activity.  
Public Property(Optional) Contains the Integer ID generated by the software if the Activity is not yet complete (that is, the log file for the specified Activity is not yet ready to return).

Note: Set the TokenID to 0 the first time you create a GetFileRequest. In subsequent GetFile() method calls, pass the TokenID into the GetFileRequest object to retrieve the path to the log file.

 
Top
See Also

Reference

GetFileRequest Class
AIR.Services.ActivityManagement.Api Namespace