Update

---

Set a job datasource

Set a job datasource

patch

/jobs/{jobId}/datasource

Authorizations

Path parameters

jobIdanyrequired

The id associated with your job.

Body

application/jsonapplication/x-protobuf

dataSourceobject

The data source object specifying configurations for inputs and outputs. Please refer to the dedicated guide for detailed instructions.

dataDestinationobject

The data source object specifying configurations for inputs and outputs. Please refer to the dedicated guide for detailed instructions.

Responses

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.bytenite.com/v1/customer/jobs/{jobId}/datasource' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }'

200

400

401

403

404

500

503

default

200

application/json

application/x-protobuf

application/json

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-03-15T22:29:20.660Z",
    "submittedAt": "2025-03-15T22:29:20.660Z",
    "startedAt": "2025-03-15T22:29:20.660Z",
    "endedAt": "2025-03-15T22:29:20.660Z",
    "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-03-15T22:29:20.660Z",
    "createdAt": "2025-03-15T22:29:20.660Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-03-15T22:29:20.660Z"
    }
  },
  "templateInfo": {
    "id": "text",
    "partitioningEngineId": "text",
    "assemblingEngineId": "text",
    "streamable": true,
    "description": "text",
    "partitioningSchemaId": "text",
    "assemblingSchemaId": "text",
    "appSchemaId": "text",
    "appId": "text",
    "owner": "text"
  }
}

A successful response.

---

Set job parameters

Set or update job specific parameters

patch

/jobs/{jobId}/params

Authorizations

Path parameters

jobIdanyrequired

The id associated with your job.

Body

application/jsonapplication/x-protobuf

presetstring

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

partitionerobject

Sets parameters for the partitioning engine.

assemblerobject

Sets parameters for the assembling engine.

appobject

Sets parameters for the application..

Responses

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.bytenite.com/v1/customer/jobs/{jobId}/params' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "preset": "text",
    "partitioner": {},
    "assembler": {},
    "app": {}
  }'

200

400

401

403

404

500

503

default

200

application/json

application/x-protobuf

application/json

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-03-15T22:29:20.660Z",
    "submittedAt": "2025-03-15T22:29:20.660Z",
    "startedAt": "2025-03-15T22:29:20.660Z",
    "endedAt": "2025-03-15T22:29:20.660Z",
    "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-03-15T22:29:20.660Z",
    "createdAt": "2025-03-15T22:29:20.660Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-03-15T22:29:20.660Z"
    }
  },
  "templateInfo": {
    "id": "text",
    "partitioningEngineId": "text",
    "assemblingEngineId": "text",
    "streamable": true,
    "description": "text",
    "partitioningSchemaId": "text",
    "assemblingSchemaId": "text",
    "appSchemaId": "text",
    "appId": "text",
    "owner": "text"
  }
}

A successful response.

---

Set a job name

Set a job name

patch

/jobs/{jobId}/jobname

Authorizations

Path parameters

jobIdanyrequired

The id associated with your job.

Body

application/jsonapplication/x-protobuf

string

Example: My Job

Responses

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.bytenite.com/v1/customer/jobs/{jobId}/jobname' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '"My Job"'

200

400

401

403

404

500

503

default

200

application/json

application/x-protobuf

application/json

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-03-15T22:29:20.660Z",
    "submittedAt": "2025-03-15T22:29:20.660Z",
    "startedAt": "2025-03-15T22:29:20.660Z",
    "endedAt": "2025-03-15T22:29:20.660Z",
    "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-03-15T22:29:20.660Z",
    "createdAt": "2025-03-15T22:29:20.660Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-03-15T22:29:20.660Z"
    }
  },
  "templateInfo": {
    "id": "text",
    "partitioningEngineId": "text",
    "assemblingEngineId": "text",
    "streamable": true,
    "description": "text",
    "partitioningSchemaId": "text",
    "assemblingSchemaId": "text",
    "appSchemaId": "text",
    "appId": "text",
    "owner": "text"
  }
}

A successful response.

---

Set job configs

Set or update execution parameters/configurations

patch

/jobs/{jobId}/configs

Authorizations

Path parameters

jobIdanyrequired

The id associated with your job.

Body

application/jsonapplication/x-protobuf

taskTimeoutinteger · int64

jobTimeoutinteger · int64

isTestJobboolean

Responses

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.bytenite.com/v1/customer/jobs/{jobId}/configs' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "taskTimeout": 1,
    "jobTimeout": 1,
    "isTestJob": true
  }'

200

400

401

403

404

500

503

default

200

application/json

application/x-protobuf

application/json

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-03-15T22:29:20.660Z",
    "submittedAt": "2025-03-15T22:29:20.660Z",
    "startedAt": "2025-03-15T22:29:20.660Z",
    "endedAt": "2025-03-15T22:29:20.660Z",
    "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-03-15T22:29:20.660Z",
    "createdAt": "2025-03-15T22:29:20.660Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-03-15T22:29:20.660Z"
    }
  },
  "templateInfo": {
    "id": "text",
    "partitioningEngineId": "text",
    "assemblingEngineId": "text",
    "streamable": true,
    "description": "text",
    "partitioningSchemaId": "text",
    "assemblingSchemaId": "text",
    "appSchemaId": "text",
    "appId": "text",
    "owner": "text"
  }
}

A successful response.