Managing Jobs
The services for job management are available in the TW.AnalysisServices.JobManagementServicesAPI resource.
The following table provides information about the purpose, input parameters, and the result of each service:
|
Service Name and Purpose
|
Input Parameters
|
Result
|
||||
|---|---|---|---|---|---|---|
|
Parameter Name
|
Base Type
|
Description
|
||||
|
EndStatefulSession — Ends the HTTP stateful session.
|
—
|
—
|
—
|
—
|
||
|
ExecuteJob — Creates and submits an analysis job that is executed synchronously.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns the result of the analysis job that is executed. This is an infotable in the same format as the resultDatashape of the model.
|
||
|
modelName
|
String
|
Specifies the name of the model to be executed.
|
||||
|
inputParams
|
Infotable
|
Specifies the inputs to the job. This is an infotable in the same format as the inputDatashape of the model.
|
||||
|
extraParams
|
JSON
|
Specifies additional parameters in JSON format. This parameter is optional.
|
||||
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a job.
|
||||
|
GetJobErrors — Retrieves details for a failed job.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns failure details if the result of job execution is FAILED. This is an infotable in the same format as TW.AnalysisServices.JobErrorDataShape.
|
||
|
jobId
|
String
|
Specifies the ID of the job to query its status.
|
||||
|
GetJobResultFiles — Retrieves names and links of the result file of a job.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns the names and links of the result files for the job. This is an infotable in the same format as TW.AnalysisServices.JobFilesDatashape.
|
||
|
jobId
|
String
|
Specifies the ID of the job to query its status.
|
||||
|
GetJobResults — Retrieves result of a submitted job.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns result of the submitted job. This is an infotable in the same format as the resultDatashape of the model.
|
||
|
jobId
|
String
|
Specifies the ID of the job to query its status.
|
||||
|
GetJobStatus — Retrieves status of a submitted job.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns one of the following statuses of the submitted job:
• WAITING
• INPROCESS
• COMPLETED
• FAILED
|
||
|
jobId
|
String
|
Specifies the ID of the job to query its status.
|
||||
|
IsStatefulSession — Checks if the current HTTP session is a stateful session.
|
—
|
—
|
—
|
Returns a boolean value of true that indicates if the current session is a stateful session.
|
||
|
QueryJobs — Returns job information based on the query.
|
values
|
Infotable
|
Specifies the attributes of the job in the form of a collection of multiple value rows.
|
Returns information about the model in the forma of an infotable that has the PTC.Capability.Analysis.SolvableDataShape data shape.
|
||
|
query
|
Query
|
Specifies the query that includes what information is required about a particular job.
|
||||
|
RetryJob — Retries the execution of the specified job if the status of job is FAILED or INPROCESS.
|
providerName
|
String
|
Specifies the name of the provider.
|
After retrying a particular job, it returns a message that states either the success or failed status of the job.
|
||
|
jobId
|
String
|
Specifies the ID of the job to query its status.
|
||||
|
StartStatefulSession — Starts a HTTP stateful session.
|
—
|
—
|
—
|
—
|
||
|
SubmitJob — Creates and submits an analysis job that is executed asynchronously.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns the ID of the analysis job that is created.
|
||
|
modelName
|
String
|
Specifies the name of the model to be executed.
|
||||
|
inputParams
|
Infotable
|
Specifies the inputs to the job. This is an infotable in the same format as the inputDatashape of the model.
|
||||
|
extraParams
|
JSON
|
Specifies additional parameters in JSON format. This parameter is optional.
|
||||
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a job.
|
||||
