GetJob Method (IJobsManager)

In This Topic

Get the details of a job by jobId. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

Job GetJob( 
   string jobId,
   bool extProps,
   bool holds
)

Function GetJob( _
   ByVal jobId As String, _
   Optional ByVal extProps As Boolean, _
   Optional ByVal holds As Boolean _
) As Job

Parameters

jobId: The id of the job.
extProps: Indicates whether to return extended and related properties for the job.
holds: Indicates whether to return hold information for the job.

Example

return await QueuedTask.Run(() => { var job = WorkflowClientModule.JobsManager.GetJob("123456789", true, true); });

How to get a job

// GetJob returns an existing job
try
{
  var jobManager = WorkflowClientModule.JobsManager;
  var job = jobManager.GetJob(jobId);
  // Do something with the job
}
catch (NotConnectedException)
{
  // Not connected to Workflow Manager server, do some error handling
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.2 or higher.

Reference

IJobsManager Interface
IJobsManager Members

Send feedback