Update

PreviousRead NextManage

Last updated 2 days ago

Was this helpful?

Set a job datasource

patch

/jobs/{jobId}/datasource

Authorizations

Path parameters

jobIdanyrequired

The id associated with your job.

Body

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

cURL

JavaScript

Python

HTTP

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

application/json

application/x-protobuf

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

presetstring

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

partitionerobject

Configuration for the partitioning process/service.

assemblerobject

Configuration for the assembling process/service.

appobject

Your application configurations.

Responses

cURL

JavaScript

Python

HTTP

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

application/json

application/x-protobuf

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

A successful response.

Set a job name

patch

/jobs/{jobId}/jobname

Authorizations

Path parameters

jobIdanyrequired

The id associated with your job.

Body

string

Example: My Job

Responses

cURL

JavaScript

Python

HTTP

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

application/json

application/x-protobuf

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

taskTimeoutinteger · int64

jobTimeoutinteger · int64

isTestJobboolean

Responses

cURL

JavaScript

Python

HTTP

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

application/json

application/x-protobuf

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

A successful response.

Set a job datasource

Show child attributes

Show child attributes

Set job parameters

Set a job name

Set job configs