Class ProcessesService

OGC Features API processes class

Hierarchy

Service
- ProcessesService

Index

Constructors

Accessors

Methods

dismissJob executeProcess getConformance getJob getJobResults getJobs getProcess getProcesses

Constructors

constructor

new ProcessesService(config): ProcessesService
constructor
Parameters
- config: IServiceConfig
Returns ProcessesService
Inherited from Service.constructor
- Defined in shared/dist/service.d.ts:49

Accessors

baseUrl

get baseUrl(): string
base url

Returns string
Inherited from Service.baseUrl
- Defined in shared/dist/service.d.ts:53

Methods

dismissJob

dismissJob(jobId, options?): Promise<IJobInfo>
Dismiss a job by its id
Parameters
- jobId: string
- options: IServiceRequestOptions = {}
  
  options
Returns Promise<IJobInfo>
- Defined in processes/src/processes.ts:142

executeProcess

executeProcess<T>(processId, options): Promise<TExecuteProcessResponse<T>>
Execute a process by its id.
Type Parameters
- T extends TProcessRequestExecutionMode
Parameters
- processId: string
  
  process id
- options: IExecuteProcessOptions<T>
  
  options
Returns Promise<TExecuteProcessResponse<T>>
- Defined in processes/src/processes.ts:56

getConformance

getConformance(options?): Promise<IGetConformanceResponse>
get a list of conformed standards
Parameters
- Optional options: IServiceRequestOptions
  
  options
Returns Promise<IGetConformanceResponse>
Inherited from Service.getConformance
- Defined in shared/dist/service.d.ts:58

getJob

getJob(jobId, options?): Promise<IJobInfo>
Get a job by its id
Parameters
- jobId: string
- options: IServiceRequestOptions = {}
  
  options
Returns Promise<IJobInfo>
- Defined in processes/src/processes.ts:109

getJobResults

getJobResults(jobId, options?): Promise<TJobResult>
Get a jobs results by its id

note: only JSON results are supported.
Parameters
- jobId: string
- options: IServiceRequestOptions = {}
  
  options
Returns Promise<TJobResult>
- Defined in processes/src/processes.ts:127

getJobs

getJobs(options?): Promise<IJobsResponse>
Get a list of jobs
Parameters
- options: IGetJobsOptions = {}
  
  options
Returns Promise<IJobsResponse>
- Defined in processes/src/processes.ts:88

getProcess

getProcess(processId, options?): Promise<IProcess>
Get a process by its id.
Parameters
- processId: string
  
  process id
- options: IServiceRequestOptions = {}
  
  options
Returns Promise<IProcess>
- Defined in processes/src/processes.ts:42

getProcesses

getProcesses(options?): Promise<IProcessesResponse>
Get a list of processes
Parameters
- options: IGetProcessesRequest = {}
  
  options
Returns Promise<IProcessesResponse>
- Defined in processes/src/processes.ts:25

Generated using TypeDoc