Read

PreviousCreate NextUpdate

Last updated 1 month ago

Was this helpful?

Get job

get

Get job properties

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Responses

objectOptional

get

GET /v1/customer/jobs/{jobId} HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-04-19T02:31:12.831Z",
    "submittedAt": "2025-04-19T02:31:12.831Z",
    "startedAt": "2025-04-19T02:31:12.831Z",
    "endedAt": "2025-04-19T02:31:12.831Z",
    "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-04-19T02:31:12.831Z",
    "createdAt": "2025-04-19T02:31:12.831Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-04-19T02:31:12.831Z"
    },
    "appId": "text"
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}

Get results

get

Get job results

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Responses

objectOptional

get

GET /v1/customer/jobs/{jobId}/results HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "results": [
    {
      "name": "text",
      "link": "text"
    }
  ]
}

Get jobs

get

Get all jobs for user with optional filters

Authorizations

Query parameters

pagination.limitanyOptional

Results per page

pagination.offsetanyOptional

The number of items to skip before starting to collect the result set

orderByanyOptional

Responses

objectOptional

get

GET /v1/customer/jobs HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  },
  "data": [
    {
      "id": "text",
      "templateId": "text",
      "name": "text",
      "config": {
        "taskTimeout": 1,
        "jobTimeout": 1,
        "isTestJob": true
      },
      "priority": "EXECUTION_PRIORITY_UNDEFINED",
      "startAt": "2025-04-19T02:31:12.831Z",
      "submittedAt": "2025-04-19T02:31:12.831Z",
      "startedAt": "2025-04-19T02:31:12.831Z",
      "endedAt": "2025-04-19T02:31:12.831Z",
      "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-04-19T02:31:12.831Z",
      "createdAt": "2025-04-19T02:31:12.831Z",
      "paymentAmount": 1,
      "numUnitsEstimation": "text",
      "numChunks": 1,
      "errorMessage": "text",
      "description": "text",
      "stateTimestamps": {
        "ANY_ADDITIONAL_PROPERTY": "2025-04-19T02:31:12.831Z"
      },
      "appId": "text"
    }
  ]
}

Get jobs filtered

post

Get all jobs for user and filter them

Authorizations

Body

paginationobjectOptional

filtersobject[]Optional

orderBystringOptional

Responses

objectOptional

post

POST /v1/customer/jobs/filter HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "pagination": {
    "limit": 1,
    "offset": 1
  },
  "filters": [
    {
      "field": "text",
      "condition": "FILTER_CONDITION_EQ",
      "value": {
        "@type": "type.googleapis.com/google.protobuf.Value",
        "value": "vaulue to filter (any type)"
      }
    }
  ],
  "orderBy": "text"
}

{
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  },
  "data": [
    {
      "id": "text",
      "templateId": "text",
      "name": "text",
      "config": {
        "taskTimeout": 1,
        "jobTimeout": 1,
        "isTestJob": true
      },
      "priority": "EXECUTION_PRIORITY_UNDEFINED",
      "startAt": "2025-04-19T02:31:12.831Z",
      "submittedAt": "2025-04-19T02:31:12.831Z",
      "startedAt": "2025-04-19T02:31:12.831Z",
      "endedAt": "2025-04-19T02:31:12.831Z",
      "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-04-19T02:31:12.831Z",
      "createdAt": "2025-04-19T02:31:12.831Z",
      "paymentAmount": 1,
      "numUnitsEstimation": "text",
      "numChunks": 1,
      "errorMessage": "text",
      "description": "text",
      "stateTimestamps": {
        "ANY_ADDITIONAL_PROPERTY": "2025-04-19T02:31:12.831Z"
      },
      "appId": "text"
    }
  ]
}