Update
Set a job datasource
The id associated with your job.
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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-08-27T21:51:41.803Z",
"submittedAt": "2025-08-27T21:51:41.803Z",
"startedAt": "2025-08-27T21:51:41.803Z",
"endedAt": "2025-08-27T21:51:41.803Z",
"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-08-27T21:51:41.803Z",
"createdAt": "2025-08-27T21:51:41.803Z",
"paymentAmount": 1,
"numUnitsEstimation": "text",
"numChunks": 1,
"errorMessage": "text",
"description": "text",
"stateTimestamps": {
"ANY_ADDITIONAL_PROPERTY": "2025-08-27T21:51:41.803Z"
},
"appId": "text",
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
},
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
}
Set or update job specific parameters
The id associated with your job.
[Deprecated] Preset configuration. This field is no longer in use.
Sets parameters for the partitioning engine.
Sets parameters for the assembling engine.
Sets parameters for the application..
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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-08-27T21:51:41.803Z",
"submittedAt": "2025-08-27T21:51:41.803Z",
"startedAt": "2025-08-27T21:51:41.803Z",
"endedAt": "2025-08-27T21:51:41.803Z",
"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-08-27T21:51:41.803Z",
"createdAt": "2025-08-27T21:51:41.803Z",
"paymentAmount": 1,
"numUnitsEstimation": "text",
"numChunks": 1,
"errorMessage": "text",
"description": "text",
"stateTimestamps": {
"ANY_ADDITIONAL_PROPERTY": "2025-08-27T21:51:41.803Z"
},
"appId": "text",
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
},
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
}
Set a job name
The id associated with your job.
My Job
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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-08-27T21:51:41.803Z",
"submittedAt": "2025-08-27T21:51:41.803Z",
"startedAt": "2025-08-27T21:51:41.803Z",
"endedAt": "2025-08-27T21:51:41.803Z",
"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-08-27T21:51:41.803Z",
"createdAt": "2025-08-27T21:51:41.803Z",
"paymentAmount": 1,
"numUnitsEstimation": "text",
"numChunks": 1,
"errorMessage": "text",
"description": "text",
"stateTimestamps": {
"ANY_ADDITIONAL_PROPERTY": "2025-08-27T21:51:41.803Z"
},
"appId": "text",
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
},
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
}
Set or update execution parameters/configurations
The id associated with your job.
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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-08-27T21:51:41.803Z",
"submittedAt": "2025-08-27T21:51:41.803Z",
"startedAt": "2025-08-27T21:51:41.803Z",
"endedAt": "2025-08-27T21:51:41.803Z",
"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-08-27T21:51:41.803Z",
"createdAt": "2025-08-27T21:51:41.803Z",
"paymentAmount": 1,
"numUnitsEstimation": "text",
"numChunks": 1,
"errorMessage": "text",
"description": "text",
"stateTimestamps": {
"ANY_ADDITIONAL_PROPERTY": "2025-08-27T21:51:41.803Z"
},
"appId": "text",
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
},
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
}
Last updated
Was this helpful?