Get Job Run - Intuned

GET

{workspaceId}

projects

{projectName}

jobs

{jobId}

runs

{jobRunId}

getJobRun

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.runs.one("my-project", "my-sample-job", "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee");

  console.log(result);
}

run();

{
  "jobRun": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "start_time": "2024-01-01T00:00:00Z",
    "end_time": "2024-01-01T00:30:00Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "job_id": "job-123e4567-e89b-12d3",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "type": "SCHEDULED",
    "status": "SUCCESS",
    "payloads": 100,
    "successful_runs": 95,
    "failed_runs": 5,
    "job_configuration_snapshot": {
      "configuration": {
        "retry": {
          "maximumAttempts": 3
        },
        "maxConcurrentRequests": 13,
        "requestTimeout": 600
      },
      "sink": {
        "type": "webhook",
        "url": "https://example.com/webhook",
        "headers": {
          "Content-Type": "application/json",
          "Authorization": "Bearer token"
        },
        "skipOnFail": false,
        "apisToSend": [
          "api1",
          "api2"
        ]
      },
      "auth_session": {
        "id": "auth-session-123"
      },
      "proxy": {
        "version": "v1",
        "url": "<string>"
      }
    },
    "error": {
      "message": "An error occurred while executing the job",
      "code": "internal-server-error",
      "category": "billing",
      "details": "<unknown>",
      "correlationId": "123e4567-e89b-12d3-a456-426614174000",
      "retirable": false,
      "doc_url": "https://docs.intunedhq.com/docs/support/errors"
    },
    "reason": {
      "type": "terminated",
      "message": "<string>",
      "details": "<unknown>",
      "doc_url": "https://docs.intunedhq.com/docs/support/reasons#no-valid-output-received"
    }
  },
  "results": {
    "signed_url": "<string>",
    "format": "<string>",
    "signed_url_expiration": "<string>",
    "size": 123,
    "key": "<string>"
  }
}

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.

jobRunId

string<uuid>

required

The job run ID. This can be obtained from the get job runs endpoint or from the result of the trigger endpoint for a job.

Response

Job run information and results

jobRun

object

required

Show child attributes

jobRun.id

string<uuid>

required

Unique identifier for the job run

Example:

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

jobRun.start_time

string

required

Timestamp when the job run started

Example:

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

jobRun.end_time

string | null

required

Timestamp when the job run ended (null if still running)

Example:

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

jobRun.workspace_id

string<uuid>

required

UUID of the workspace this job run belongs to

Example:

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

jobRun.project_id

string<uuid>

required

UUID of the project this job run belongs to

Example:

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

jobRun.job_id

string

required

ID of the job this run belongs to

Example:

"job-123e4567-e89b-12d3"

jobRun.created_at

string

required

Timestamp when the job run was created

Example:

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

jobRun.updated_at

string

required

Timestamp when the job run was last updated

Example:

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

jobRun.type

enum<string>

required

Type of the job run

Available options:

MANUAL,

SCHEDULED

Example:

"SCHEDULED"

jobRun.status

enum<string>

required

Current status of the job run

Available options:

CANCELED,

PENDING,

PAUSED,

PAUSING,

RESUMING,

SUCCESS,

FAILURE,

TERMINATED,

COMPLETED

Example:

"SUCCESS"

jobRun.payloads

integer | null

required

Total number of payloads in the job run

Example:

100

jobRun.successful_runs

integer | null

required

Number of successful API calls in the job run

Example:

95

jobRun.failed_runs

integer | null

required

Number of failed API calls in the job run

Example:

5

jobRun.job_configuration_snapshot

object

required

Snapshot of job configuration at the time of the job run

Show child attributes

jobRun.job_configuration_snapshot.configuration

object

required

Job configuration settings

Show child attributes

jobRun.job_configuration_snapshot.configuration.retry

object

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

Show child attributes

jobRun.job_configuration_snapshot.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 }

jobRun.job_configuration_snapshot.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

jobRun.job_configuration_snapshot.configuration.requestTimeout

integer

default:600

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

Example:

600

jobRun.job_configuration_snapshot.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

jobRun.job_configuration_snapshot.sink.type

enum<string>

required

Available options:

webhook

jobRun.job_configuration_snapshot.sink.url

string

required

The URL to which the webhook will send the data.

Example:

"https://example.com/webhook"

jobRun.job_configuration_snapshot.sink.headers

object

Optional headers to be sent with the webhook request.

Show child attributes

jobRun.job_configuration_snapshot.sink.headers.{key}

string

Example:

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

jobRun.job_configuration_snapshot.sink.skipOnFail

boolean

default:false

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

jobRun.job_configuration_snapshot.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"]

jobRun.job_configuration_snapshot.auth_session

object

Authentication session information for the job

Show child attributes

jobRun.job_configuration_snapshot.auth_session.id

string

required

jobRun.job_configuration_snapshot.auth_session.checkAttempts

integer

default:3

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

Example:

3

jobRun.job_configuration_snapshot.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" }

jobRun.job_configuration_snapshot.proxy

object

Proxy configuration for the job, stored as JSONB

Show child attributes

jobRun.job_configuration_snapshot.proxy.version

enum<string>

required

Available options:

v1

jobRun.job_configuration_snapshot.proxy.url

string<uri>

required

jobRun.error

object

Error information if the job run failed, stored as JSONB

Show child attributes

jobRun.error.message

string

required

Error message describing the failure

Example:

"An error occurred while executing the job"

jobRun.error.code

enum<string>

required

Optional error code for more specific error identification

Available options:

internal-server-error,

insufficient-resource-credits

Example:

"internal-server-error"

jobRun.error.category

enum<string>

required

Available options:

billing,

infrastructure

jobRun.error.details

any

jobRun.error.correlationId

string

Optional correlation ID for tracking the error

Example:

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

jobRun.error.retirable

boolean

default:false

jobRun.error.doc_url

string

Optional documentation URL for more information

Example:

"https://docs.intunedhq.com/docs/support/errors"

jobRun.reason

object

Reason for job run state change, stored as JSONB

Show child attributes

jobRun.reason.type

enum<string>

required

Available options:

terminated,

user-request,

auth-session-not-found,

auth-session-invalid-mid-job,

auth-session-validate-dependency-failed,

auth-session-locked,

another-job-run-active,

insufficient-resource-credits,

s3-sink-error

jobRun.reason.message

string

required

jobRun.reason.details

any

jobRun.reason.doc_url

string

Optional documentation URL for more information

Example:

"https://docs.intunedhq.com/docs/support/reasons#no-valid-output-received"

results

object

Show child attributes

results.signed_url

string

required

results.format

string

required

results.signed_url_expiration

string

results.size

number

results.key

string

Terminate Job RunTerminate a job run by ID.

⌘I

getJobRun

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.runs.one("my-project", "my-sample-job", "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee");

  console.log(result);
}

run();

{
  "jobRun": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "start_time": "2024-01-01T00:00:00Z",
    "end_time": "2024-01-01T00:30:00Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "job_id": "job-123e4567-e89b-12d3",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "type": "SCHEDULED",
    "status": "SUCCESS",
    "payloads": 100,
    "successful_runs": 95,
    "failed_runs": 5,
    "job_configuration_snapshot": {
      "configuration": {
        "retry": {
          "maximumAttempts": 3
        },
        "maxConcurrentRequests": 13,
        "requestTimeout": 600
      },
      "sink": {
        "type": "webhook",
        "url": "https://example.com/webhook",
        "headers": {
          "Content-Type": "application/json",
          "Authorization": "Bearer token"
        },
        "skipOnFail": false,
        "apisToSend": [
          "api1",
          "api2"
        ]
      },
      "auth_session": {
        "id": "auth-session-123"
      },
      "proxy": {
        "version": "v1",
        "url": "<string>"
      }
    },
    "error": {
      "message": "An error occurred while executing the job",
      "code": "internal-server-error",
      "category": "billing",
      "details": "<unknown>",
      "correlationId": "123e4567-e89b-12d3-a456-426614174000",
      "retirable": false,
      "doc_url": "https://docs.intunedhq.com/docs/support/errors"
    },
    "reason": {
      "type": "terminated",
      "message": "<string>",
      "details": "<unknown>",
      "doc_url": "https://docs.intunedhq.com/docs/support/reasons#no-valid-output-received"
    }
  },
  "results": {
    "signed_url": "<string>",
    "format": "<string>",
    "signed_url_expiration": "<string>",
    "size": 123,
    "key": "<string>"
  }
}

Get started

Authorizations

Path Parameters

Response