---
title: JobApi
slug: data-platform/connect-platform/app-sdk-api-reference-interfaces-jobapi
docTags: 
createdAt: 2026-08-05T20:06:33.697Z
---

[OCP App SDK](docId\:gxEU_0AA37IEZJK-uoVcT)

***

[OCP App SDK](docId\:gxEU_0AA37IEZJK-uoVcT) / JobApi

# Interface: JobApi

Defined in: [src/jobs/JobApi.ts:71](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/jobs/JobApi.ts#L71)

Interface to trigger and monitor jobs

## Methods

### getDetail()

:::BlockQuote
**getDetail**(`jobId`): `Promise`\<[`` `JobDetail` ``](docId\:OBzuMDvkfyz4gF7Log9c5)>
:::

Defined in: [src/jobs/JobApi.ts:73](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/jobs/JobApi.ts#L73)

### Parameters

### jobId

`string`

### Returns

`Promise`\<[`` `JobDetail` ``](docId\:OBzuMDvkfyz4gF7Log9c5)>

***

### getStatus()

:::BlockQuote
**getStatus**(`jobId`): `Promise`\<[`` `JobRunStatus` ``](docId\:snx5iGUSvkFy58WOuDqDd)>
:::

Defined in: [src/jobs/JobApi.ts:74](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/jobs/JobApi.ts#L74)

### Parameters

### jobId

`string`

### Returns

`Promise`\<[`` `JobRunStatus` ``](docId\:snx5iGUSvkFy58WOuDqDd)>

***

### trigger()

:::BlockQuote
**trigger**(`jobName`, `parameters`): `Promise`\<[`` `JobDetail` ``](docId\:OBzuMDvkfyz4gF7Log9c5)>
:::

Defined in: [src/jobs/JobApi.ts:72](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/jobs/JobApi.ts#L72)

### Parameters

### jobName

`string`

### parameters

[`` `ValueHash` ``](docId\:iBlCGxR75KaoapohMUe5k)

### Returns

`Promise`\<[`` `JobDetail` ``](docId\:OBzuMDvkfyz4gF7Log9c5)>