Run API - Result

GET

{workspaceId}

projects

{projectName}

run

{runId}

result

runApiResult

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.run.result("my-project", "aabbccddeeffggh");

  console.log(result);
}

run();

{
  "runId": "<string>",
  "status": "completed",
  "result": "<unknown>",
  "extendedPayloads": [
    {
      "api": "<string>",
      "runId": "<string>",
      "parameters": {
        "param1": "value1",
        "param2": 42,
        "param3": true
      }
    }
  ],
  "error": {
    "message": "An error occurred while executing the run",
    "category": "infrastructure",
    "code": "script-process-crashed",
    "retirable": false,
    "doc_url": "https://docs.intunedhq.com/docs/support/errors#run-execution-error",
    "correlation_id": "123e4567-e89b-12d3-a456-426614174000",
    "details": "<unknown>"
  },
  "message": "<string>",
  "reason": {
    "type": "auth-session-validate-dependency-failed",
    "message": "<string>",
    "doc_url": "https://docs.intunedhq.com/docs/support/reasons#terminated",
    "details": "<unknown>"
  }
}

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.

runId

string<nanoid>

required

Run ID

Response

200 - application/json

Run result with status and output data.

runId

string

required

Unique identifier for the run, nanoId of 21 characters

status

enum<string>

required

Status of the run execution

Available options:

pending,

started,

completed,

canceled,

failed

Example:

"completed"

result

any

Output result of the run execution

extendedPayloads

object[]

Extended payloads from the run execution

Show child attributes

extendedPayloads.api

string

required

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

extendedPayloads.runId

string

extendedPayloads.parameters

object

The parameters to be passed to the API.

Show child attributes

extendedPayloads.parameters.{key}

any

Example:

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

error

object

Show child attributes

error.message

string

required

Error message describing the failure

Example:

"An error occurred while executing the run"

error.category

enum<string>

required

Available options:

infrastructure,

execution,

auth,

user,

billing

error.code

enum<string>

Optional error code for more specific error identification

Available options:

internal-server-error,

script-process-crashed,

unexpected,

script-process-crashed,

script-execution-exception,

script-no-valid-output-received,

result-too-big-error,

script-timeout,

script-unexpected-error,

auth-check-failed,

all-attempts-failed,

check-attempts-failed,

create-attempts-failed,

post-create-check-attempts-failed,

api-attempts-failed,

onepassword-integration-error,

job-run-terminated

Example:

"script-process-crashed"

error.retirable

boolean

default:false

error.doc_url

string

Optional URL to documentation for this error

Example:

"https://docs.intunedhq.com/docs/support/errors#run-execution-error"

error.correlation_id

string

Optional correlation ID for tracing the error in logs

Example:

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

error.details

any

message

string

Error or reason message

reason

object

Show child attributes

reason.type

enum<string>

required

Available options:

auth-session-validate-dependency-failed,

terminated,

job-run-paused,

job-run-terminated,

failed-to-initialize-job-run,

api-access-disabled,

cancelled-user-action

reason.message

string

required

reason.doc_url

string

Optional URL to documentation for this error

Example:

"https://docs.intunedhq.com/docs/support/reasons#terminated"

reason.details

any

Overview

⌘I

runApiResult

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.run.result("my-project", "aabbccddeeffggh");

  console.log(result);
}

run();

{
  "runId": "<string>",
  "status": "completed",
  "result": "<unknown>",
  "extendedPayloads": [
    {
      "api": "<string>",
      "runId": "<string>",
      "parameters": {
        "param1": "value1",
        "param2": 42,
        "param3": true
      }
    }
  ],
  "error": {
    "message": "An error occurred while executing the run",
    "category": "infrastructure",
    "code": "script-process-crashed",
    "retirable": false,
    "doc_url": "https://docs.intunedhq.com/docs/support/errors#run-execution-error",
    "correlation_id": "123e4567-e89b-12d3-a456-426614174000",
    "details": "<unknown>"
  },
  "message": "<string>",
  "reason": {
    "type": "auth-session-validate-dependency-failed",
    "message": "<string>",
    "doc_url": "https://docs.intunedhq.com/docs/support/reasons#terminated",
    "details": "<unknown>"
  }
}

Get started

Authorizations

Path Parameters

Response