Get Job - Intuned

GET

{workspaceId}

projects

{projectName}

jobs

{jobId}

getJob

import { IntunedClient } from "@intuned/client";

const intunedClient = new IntunedClient({
  workspaceId: "123e4567-e89b-12d3-a456-426614174000",
  apiKey: process.env["INTUNED_API_KEY"] ?? "",
});

async function run() {
  const result = await intunedClient.project.jobs.one("my-project", "my-sample-job");

  console.log(result);
}

run();

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "configuration": {
    "retry": {
      "maximumAttempts": 3
    },
    "maxConcurrentRequests": 13,
    "requestTimeout": 600
  },
  "created_at": "2024-01-01T00:00:00Z",
  "state": "ACTIVE",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "sink": {
    "type": "webhook",
    "url": "https://example.com/webhook",
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "skipOnFail": false,
    "apisToSend": [
      "api1",
      "api2"
    ]
  },
  "next_run_time": "2024-01-01T00:00:00Z",
  "last_run_time": "2024-01-01T00:00:00Z",
  "payload": [
    {
      "parameters": {
        "param1": "value1",
        "param2": 42,
        "param3": true
      },
      "apiName": "<string>",
      "requestTimeout": 600,
      "retry": {
        "maximumAttempts": 3
      }
    }
  ],
  "schedule": {
    "jitter": 1,
    "intervals": [
      {
        "every": 1
      }
    ],
    "calendars": [
      {
        "second": 29,
        "minute": 29,
        "hour": 11,
        "dayOfWeek": "SUNDAY",
        "dayOfMonth": 16,
        "month": "JANUARY",
        "year": 5984,
        "comment": "<string>"
      }
    ]
  },
  "auth_session": {
    "id": "auth-session-123"
  },
  "proxy": "http://username:[email protected]:8080"
}

Authorizations

x-api-key

string

header

required

API Key used to authenticate your requests. How to create one.

Path Parameters

workspaceId

string<uuid>

required

Your workspace ID. How to find it?

projectName

string

required

Your project name. It is the name you provide when creating a project.

jobId

string

required

Your job ID. It is the ID of the job you provide when creating it.

Response

Detailed information about a specific job

string

required

The ID of the job. Has to be a valid URL slug.

Minimum string length: 7

Example:

"123e4567-e89b-12d3-a456-426614174000"

configuration

object

required

Job configuration settings

Show child attributes

configuration.retry

object

The retry policy of the job. Configure how many retries and the delay between them for each payload.

Show child attributes

configuration.retry.maximumAttempts

integer

default:3

Maximum number of attempts to retry the run in case of failure

Required range: x >= 1

Example:

3

Example:

{ "maximumAttempts": 3 }

configuration.maxConcurrentRequests

number

The batch size of payloads to execute. This does not guarantee that the payloads will be executed at the same time.

Required range: 1 <= x <= 25

configuration.requestTimeout

integer

default:600

Timeout for the API request in seconds. Default is 10 minutes (600 seconds).

Example:

600

created_at

string

required

Timestamp when the job was created

Example:

"2024-01-01T00:00:00Z"

state

enum<string>

required

Current state of the job

Available options:

ACTIVE,

PAUSED

projectId

string<uuid>

required

UUID of the project this job belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

sink

Webhook Sink Configuration · object

Optional sink configuration for the job. Can be a webhook or S3 Compatible sink.

Webhook Sink Configuration
S3 Sink Configuration

Show child attributes

sink.type

enum<string>

required

Available options:

webhook

sink.url

string

required

The URL to which the webhook will send the data.

Example:

"https://example.com/webhook"

sink.headers

object

Optional headers to be sent with the webhook request.

Show child attributes

sink.headers.{key}

string

Example:

{
  "Content-Type": "application/json",
  "Authorization": "Bearer token"
}

sink.skipOnFail

boolean

default:false

If true, the webhook will not be sent if the API execution fails.

sink.apisToSend

string[]

List of API names to be sent to the webhook. If not provided, all APIs will be sent.

Minimum array length: 1

Example:

["api1", "api2"]

next_run_time

string | null

The timestamp of the next scheduled job run. null if the job does not have a schedule.

Example:

"2024-01-01T00:00:00Z"

last_run_time

string | null

Timestamp of the last completed run

Example:

"2024-01-01T00:00:00Z"

payload

object[]

Array of API calls to be executed

Show child attributes

payload.parameters

object

required

The parameters to be passed to the API.

Show child attributes

payload.parameters.{key}

any

Example:

{
  "param1": "value1",
  "param2": 42,
  "param3": true
}

payload.apiName

string

required

The name of the API to be executed. This is the file path relative to the api folder inside your project.

payload.requestTimeout

integer

default:600

Timeout for the API request in seconds. Default is 10 minutes (600 seconds).

Example:

600

payload.retry

object

Retry policy configurations in case of failure.

Show child attributes

payload.retry.maximumAttempts

integer

default:3

Maximum number of attempts to retry the run in case of failure

Required range: x >= 1

Example:

3

Example:

{ "maximumAttempts": 3 }

schedule

object

Schedule configurations for the job. If set, the job will periodically run according to this configuration. The configurations are used to calculate the closest next run time.

Show child attributes

schedule.jitter

Required range: x >= 0

schedule.intervals

object[]

An array of interval objects

Show child attributes

schedule.intervals.every

required

number of milliseconds of interval

Required range: x >= 0

schedule.calendars

object[]

An array of calendar objects

Show child attributes

schedule.calendars.second

Seconds of the calendar, a number in the range 0 - 59

Required range: 0 <= x <= 59

schedule.calendars.minute

Minutes of the calendar, a number in the range 0 - 59

Required range: 0 <= x <= 59

schedule.calendars.hour

Hours of the calendar, a number in the range 0 - 23

Required range: 0 <= x <= 23

schedule.calendars.dayOfWeek

Days of week, one of SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY

Available options:

SUNDAY,

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY

schedule.calendars.dayOfMonth

Days of the month, a number in the range 1 - 31

Required range: 1 <= x <= 31

schedule.calendars.month

Months, one of JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER

Available options:

JANUARY,

FEBRUARY,

MARCH,

APRIL,

MAY,

JUNE,

JULY,

AUGUST,

SEPTEMBER,

OCTOBER,

NOVEMBER,

DECEMBER

schedule.calendars.year

Full year. For example: 2024

Required range: 1970 <= x <= 9999

schedule.calendars.comment

string

A comment to describe what the calendar is supposed to represent

auth_session

object

Authentication session information for the job

Show child attributes

auth_session.id

string

required

auth_session.checkAttempts

integer

default:3

Number of attempts to check the validity of the auth session before recreating it.

Example:

3

auth_session.createAttempts

integer

default:3

Number of attempts to create a new auth session if the current one is invalid or expired.

Example:

3

Example:

{ "id": "auth-session-123" }

proxy

string

Proxy URL if configured for the job

Example:

"http://username:[email protected]:8080"

Delete JobDeletes a job by ID.

⌘I

getJob

import { IntunedClient } from "@intuned/client";

const intunedClient = new IntunedClient({
  workspaceId: "123e4567-e89b-12d3-a456-426614174000",
  apiKey: process.env["INTUNED_API_KEY"] ?? "",
});

async function run() {
  const result = await intunedClient.project.jobs.one("my-project", "my-sample-job");

  console.log(result);
}

run();

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "configuration": {
    "retry": {
      "maximumAttempts": 3
    },
    "maxConcurrentRequests": 13,
    "requestTimeout": 600
  },
  "created_at": "2024-01-01T00:00:00Z",
  "state": "ACTIVE",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "sink": {
    "type": "webhook",
    "url": "https://example.com/webhook",
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "skipOnFail": false,
    "apisToSend": [
      "api1",
      "api2"
    ]
  },
  "next_run_time": "2024-01-01T00:00:00Z",
  "last_run_time": "2024-01-01T00:00:00Z",
  "payload": [
    {
      "parameters": {
        "param1": "value1",
        "param2": 42,
        "param3": true
      },
      "apiName": "<string>",
      "requestTimeout": 600,
      "retry": {
        "maximumAttempts": 3
      }
    }
  ],
  "schedule": {
    "jitter": 1,
    "intervals": [
      {
        "every": 1
      }
    ],
    "calendars": [
      {
        "second": 29,
        "minute": 29,
        "hour": 11,
        "dayOfWeek": "SUNDAY",
        "dayOfMonth": 16,
        "month": "JANUARY",
        "year": 5984,
        "comment": "<string>"
      }
    ]
  },
  "auth_session": {
    "id": "auth-session-123"
  },
  "proxy": "http://username:[email protected]:8080"
}

Get started

Authorizations

Path Parameters

Response