Update

PreviousRead NextManage

Last updated 1 month ago

Was this helpful?

Set a job datasource

patch

Set a job datasource

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Body

Responses

200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

patch

PATCH /v1/customer/jobs/{jobId}/datasource HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "dataSource": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "dataDestination": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-05-31T11:10:33.884Z",
    "submittedAt": "2025-05-31T11:10:33.884Z",
    "startedAt": "2025-05-31T11:10:33.884Z",
    "endedAt": "2025-05-31T11:10:33.884Z",
    "regions": {
      "blacklist": [
        "text"
      ],
      "whitelist": [
        "text"
      ]
    },
    "state": "JOB_STATE_NEW",
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "params": {
      "preset": "text",
      "partitioner": {},
      "assembler": {},
      "app": {}
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "duration": 1,
    "deletedAt": "2025-05-31T11:10:33.884Z",
    "createdAt": "2025-05-31T11:10:33.884Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-05-31T11:10:33.884Z"
    },
    "appId": "text"
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}

Set job parameters

patch

Set or update job specific parameters

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Body

presetstringOptional

[Deprecated] Preset configuration. This field is no longer in use.

partitionerobjectOptional

Sets parameters for the partitioning engine.

assemblerobjectOptional

Sets parameters for the assembling engine.

appobjectOptional

Sets parameters for the application..

Responses

200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

patch

PATCH /v1/customer/jobs/{jobId}/params HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "preset": "text",
  "partitioner": {},
  "assembler": {},
  "app": {}
}

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-05-31T11:10:33.884Z",
    "submittedAt": "2025-05-31T11:10:33.884Z",
    "startedAt": "2025-05-31T11:10:33.884Z",
    "endedAt": "2025-05-31T11:10:33.884Z",
    "regions": {
      "blacklist": [
        "text"
      ],
      "whitelist": [
        "text"
      ]
    },
    "state": "JOB_STATE_NEW",
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "params": {
      "preset": "text",
      "partitioner": {},
      "assembler": {},
      "app": {}
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "duration": 1,
    "deletedAt": "2025-05-31T11:10:33.884Z",
    "createdAt": "2025-05-31T11:10:33.884Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-05-31T11:10:33.884Z"
    },
    "appId": "text"
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}

Set a job name

patch

Set a job name

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Body

stringOptionalExample: My Job

Responses

200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

patch

PATCH /v1/customer/jobs/{jobId}/jobname HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8

"My Job"

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-05-31T11:10:33.884Z",
    "submittedAt": "2025-05-31T11:10:33.884Z",
    "startedAt": "2025-05-31T11:10:33.884Z",
    "endedAt": "2025-05-31T11:10:33.884Z",
    "regions": {
      "blacklist": [
        "text"
      ],
      "whitelist": [
        "text"
      ]
    },
    "state": "JOB_STATE_NEW",
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "params": {
      "preset": "text",
      "partitioner": {},
      "assembler": {},
      "app": {}
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "duration": 1,
    "deletedAt": "2025-05-31T11:10:33.884Z",
    "createdAt": "2025-05-31T11:10:33.884Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-05-31T11:10:33.884Z"
    },
    "appId": "text"
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}

Set job configs

patch

Set or update execution parameters/configurations

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Body

taskTimeoutinteger · int64Optional

jobTimeoutinteger · int64Optional

isTestJobbooleanOptional

Responses

200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

patch

PATCH /v1/customer/jobs/{jobId}/configs HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "taskTimeout": 1,
  "jobTimeout": 1,
  "isTestJob": true
}

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-05-31T11:10:33.884Z",
    "submittedAt": "2025-05-31T11:10:33.884Z",
    "startedAt": "2025-05-31T11:10:33.884Z",
    "endedAt": "2025-05-31T11:10:33.884Z",
    "regions": {
      "blacklist": [
        "text"
      ],
      "whitelist": [
        "text"
      ]
    },
    "state": "JOB_STATE_NEW",
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "params": {
      "preset": "text",
      "partitioner": {},
      "assembler": {},
      "app": {}
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "duration": 1,
    "deletedAt": "2025-05-31T11:10:33.884Z",
    "createdAt": "2025-05-31T11:10:33.884Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-05-31T11:10:33.884Z"
    },
    "appId": "text"
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}