Update the Job

Update job configuration for a specific application

PUT /v1/applications/{applicationId}/jobs/{jobId}

Update the Job

cURL

curl --request PUT \
  --url https://{instance}.domo.com/v1/applications/{applicationId}/jobs/{jobId} \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "jobId": "526906bb-e7e0-4f70-9ca0-3bb4fdf99c82",
  "jobName": "domo-labs-dev2.dev.domo.com",
  "executionTimeout": 720,
  "executionPayload": {
    "remoteInstance": "domo-labs-dev.dev.domo.com",
    "subscriberJobId": "b8ff1dc6-4426-4256-8176-1cb9482e79c0",
    "policies": {
      "AccessTokens": "85f65936-e0c3-4e74-8398-13096df9bdb3",
      "DomainWhitelist": "cd473383-9589-4d44-a85a-ffd58c0b1d55",
      "IPWhitelist": "6f570767-ec10-4d9b-b0f2-abb0bf1bd8d2",
      "OIDC": "d26a1d1e-a6c0-4367-b929-70a6e01e5b46",
      "SAML": "081d8320-c6df-4d0b-8802-97875989236d",
      "DirectSignOn": "7b1f43e1-165d-4eed-b195-491a6bedcef0"
    },
    "metricsDatasetId": "2644b5d0-344b-4bc0-b379-d3854923a29c"
  },
  "executionResponse": {},
  "accounts": [
    479
  ],
  "resources": {
    "requests": {
      "memory": "256M"
    },
    "limits": {
      "memory": "256M"
    }
  },
  "triggers": []
}
'

import requests

url = "https://{instance}.domo.com/v1/applications/{applicationId}/jobs/{jobId}"

payload = {
    "jobId": "526906bb-e7e0-4f70-9ca0-3bb4fdf99c82",
    "jobName": "domo-labs-dev2.dev.domo.com",
    "executionTimeout": 720,
    "executionPayload": {
        "remoteInstance": "domo-labs-dev.dev.domo.com",
        "subscriberJobId": "b8ff1dc6-4426-4256-8176-1cb9482e79c0",
        "policies": {
            "AccessTokens": "85f65936-e0c3-4e74-8398-13096df9bdb3",
            "DomainWhitelist": "cd473383-9589-4d44-a85a-ffd58c0b1d55",
            "IPWhitelist": "6f570767-ec10-4d9b-b0f2-abb0bf1bd8d2",
            "OIDC": "d26a1d1e-a6c0-4367-b929-70a6e01e5b46",
            "SAML": "081d8320-c6df-4d0b-8802-97875989236d",
            "DirectSignOn": "7b1f43e1-165d-4eed-b195-491a6bedcef0"
        },
        "metricsDatasetId": "2644b5d0-344b-4bc0-b379-d3854923a29c"
    },
    "executionResponse": {},
    "accounts": [479],
    "resources": {
        "requests": { "memory": "256M" },
        "limits": { "memory": "256M" }
    },
    "triggers": []
}
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    jobId: '526906bb-e7e0-4f70-9ca0-3bb4fdf99c82',
    jobName: 'domo-labs-dev2.dev.domo.com',
    executionTimeout: 720,
    executionPayload: {
      remoteInstance: 'domo-labs-dev.dev.domo.com',
      subscriberJobId: 'b8ff1dc6-4426-4256-8176-1cb9482e79c0',
      policies: {
        AccessTokens: '85f65936-e0c3-4e74-8398-13096df9bdb3',
        DomainWhitelist: 'cd473383-9589-4d44-a85a-ffd58c0b1d55',
        IPWhitelist: '6f570767-ec10-4d9b-b0f2-abb0bf1bd8d2',
        OIDC: 'd26a1d1e-a6c0-4367-b929-70a6e01e5b46',
        SAML: '081d8320-c6df-4d0b-8802-97875989236d',
        DirectSignOn: '7b1f43e1-165d-4eed-b195-491a6bedcef0'
      },
      metricsDatasetId: '2644b5d0-344b-4bc0-b379-d3854923a29c'
    },
    executionResponse: {},
    accounts: [479],
    resources: {requests: {memory: '256M'}, limits: {memory: '256M'}},
    triggers: []
  })
};

fetch('https://{instance}.domo.com/v1/applications/{applicationId}/jobs/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.domo.com/v1/applications/{applicationId}/jobs/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'jobId' => '526906bb-e7e0-4f70-9ca0-3bb4fdf99c82',
    'jobName' => 'domo-labs-dev2.dev.domo.com',
    'executionTimeout' => 720,
    'executionPayload' => [
        'remoteInstance' => 'domo-labs-dev.dev.domo.com',
        'subscriberJobId' => 'b8ff1dc6-4426-4256-8176-1cb9482e79c0',
        'policies' => [
                'AccessTokens' => '85f65936-e0c3-4e74-8398-13096df9bdb3',
                'DomainWhitelist' => 'cd473383-9589-4d44-a85a-ffd58c0b1d55',
                'IPWhitelist' => '6f570767-ec10-4d9b-b0f2-abb0bf1bd8d2',
                'OIDC' => 'd26a1d1e-a6c0-4367-b929-70a6e01e5b46',
                'SAML' => '081d8320-c6df-4d0b-8802-97875989236d',
                'DirectSignOn' => '7b1f43e1-165d-4eed-b195-491a6bedcef0'
        ],
        'metricsDatasetId' => '2644b5d0-344b-4bc0-b379-d3854923a29c'
    ],
    'executionResponse' => [
        
    ],
    'accounts' => [
        479
    ],
    'resources' => [
        'requests' => [
                'memory' => '256M'
        ],
        'limits' => [
                'memory' => '256M'
        ]
    ],
    'triggers' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.domo.com/v1/applications/{applicationId}/jobs/{jobId}"

	payload := strings.NewReader("{\n  \"jobId\": \"526906bb-e7e0-4f70-9ca0-3bb4fdf99c82\",\n  \"jobName\": \"domo-labs-dev2.dev.domo.com\",\n  \"executionTimeout\": 720,\n  \"executionPayload\": {\n    \"remoteInstance\": \"domo-labs-dev.dev.domo.com\",\n    \"subscriberJobId\": \"b8ff1dc6-4426-4256-8176-1cb9482e79c0\",\n    \"policies\": {\n      \"AccessTokens\": \"85f65936-e0c3-4e74-8398-13096df9bdb3\",\n      \"DomainWhitelist\": \"cd473383-9589-4d44-a85a-ffd58c0b1d55\",\n      \"IPWhitelist\": \"6f570767-ec10-4d9b-b0f2-abb0bf1bd8d2\",\n      \"OIDC\": \"d26a1d1e-a6c0-4367-b929-70a6e01e5b46\",\n      \"SAML\": \"081d8320-c6df-4d0b-8802-97875989236d\",\n      \"DirectSignOn\": \"7b1f43e1-165d-4eed-b195-491a6bedcef0\"\n    },\n    \"metricsDatasetId\": \"2644b5d0-344b-4bc0-b379-d3854923a29c\"\n  },\n  \"executionResponse\": {},\n  \"accounts\": [\n    479\n  ],\n  \"resources\": {\n    \"requests\": {\n      \"memory\": \"256M\"\n    },\n    \"limits\": {\n      \"memory\": \"256M\"\n    }\n  },\n  \"triggers\": []\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{instance}.domo.com/v1/applications/{applicationId}/jobs/{jobId}")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jobId\": \"526906bb-e7e0-4f70-9ca0-3bb4fdf99c82\",\n  \"jobName\": \"domo-labs-dev2.dev.domo.com\",\n  \"executionTimeout\": 720,\n  \"executionPayload\": {\n    \"remoteInstance\": \"domo-labs-dev.dev.domo.com\",\n    \"subscriberJobId\": \"b8ff1dc6-4426-4256-8176-1cb9482e79c0\",\n    \"policies\": {\n      \"AccessTokens\": \"85f65936-e0c3-4e74-8398-13096df9bdb3\",\n      \"DomainWhitelist\": \"cd473383-9589-4d44-a85a-ffd58c0b1d55\",\n      \"IPWhitelist\": \"6f570767-ec10-4d9b-b0f2-abb0bf1bd8d2\",\n      \"OIDC\": \"d26a1d1e-a6c0-4367-b929-70a6e01e5b46\",\n      \"SAML\": \"081d8320-c6df-4d0b-8802-97875989236d\",\n      \"DirectSignOn\": \"7b1f43e1-165d-4eed-b195-491a6bedcef0\"\n    },\n    \"metricsDatasetId\": \"2644b5d0-344b-4bc0-b379-d3854923a29c\"\n  },\n  \"executionResponse\": {},\n  \"accounts\": [\n    479\n  ],\n  \"resources\": {\n    \"requests\": {\n      \"memory\": \"256M\"\n    },\n    \"limits\": {\n      \"memory\": \"256M\"\n    }\n  },\n  \"triggers\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/v1/applications/{applicationId}/jobs/{jobId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jobId\": \"526906bb-e7e0-4f70-9ca0-3bb4fdf99c82\",\n  \"jobName\": \"domo-labs-dev2.dev.domo.com\",\n  \"executionTimeout\": 720,\n  \"executionPayload\": {\n    \"remoteInstance\": \"domo-labs-dev.dev.domo.com\",\n    \"subscriberJobId\": \"b8ff1dc6-4426-4256-8176-1cb9482e79c0\",\n    \"policies\": {\n      \"AccessTokens\": \"85f65936-e0c3-4e74-8398-13096df9bdb3\",\n      \"DomainWhitelist\": \"cd473383-9589-4d44-a85a-ffd58c0b1d55\",\n      \"IPWhitelist\": \"6f570767-ec10-4d9b-b0f2-abb0bf1bd8d2\",\n      \"OIDC\": \"d26a1d1e-a6c0-4367-b929-70a6e01e5b46\",\n      \"SAML\": \"081d8320-c6df-4d0b-8802-97875989236d\",\n      \"DirectSignOn\": \"7b1f43e1-165d-4eed-b195-491a6bedcef0\"\n    },\n    \"metricsDatasetId\": \"2644b5d0-344b-4bc0-b379-d3854923a29c\"\n  },\n  \"executionResponse\": {},\n  \"accounts\": [\n    479\n  ],\n  \"resources\": {\n    \"requests\": {\n      \"memory\": \"256M\"\n    },\n    \"limits\": {\n      \"memory\": \"256M\"\n    }\n  },\n  \"triggers\": []\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "OK",
  "code": 200,
  "message": "Job updated successfully"
}

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication

Path Parameters

Application_Id · string · required

ID of the application

Job_Id · string · required

ID of the job to update

Body

application/json

jobId · string · required

Job ID

Example:

"526906bb-e7e0-4f70-9ca0-3bb4fdf99c82"

jobName · string · required

Job name

Example:

"domo-labs-dev2.dev.domo.com"

executionTimeout · integer

Execution timeout in seconds

Example:

720

executionPayload · object

Show child attributes

executionResponse · object

Execution response

accounts · integer[]

List of account IDs

Example:

[479]

resources · object

Show child attributes

triggers · object[]

List of triggers

Example:

[]

Response

200 - application/json

Job updated successfully

status · string

Response status

Example:

"OK"

code · integer

HTTP status code

Example:

200

message · string

Response message

Example:

"Job updated successfully"