Go to website

Data Source

Set a job datasource

Set a job datasource

post

/jobs/datasource/{jobId}

Authorizations
Path parameters
jobIdstringrequired

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 -L \
  --request POST \
  --url 'https://api.bytenite.com/v1/customer/jobs/datasource/{jobId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"dataSource":{"dataSourceDescriptor":"s3","params":{"ANY_ADDITIONAL_PROPERTY":"anything"}},"dataDestination":{"dataSourceDescriptor":"s3","params":{"ANY_ADDITIONAL_PROPERTY":"anything"}}}'
{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-02-21T15:47:01.250Z",
    "submittedAt": "2025-02-21T15:47:01.250Z",
    "startedAt": "2025-02-21T15:47:01.250Z",
    "completedAt": "2025-02-21T15:47:01.250Z",
    "regions": {
      "blacklist": [
        "text"
      ],
      "whitelist": [
        "text"
      ]
    },
    "state": "JOB_STATE_NEW",
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "params": {
      "schema": "text",
      "data": {},
      "preset": "text",
      "partitioner": {},
      "assembler": {},
      "app": {},
      "selectedOutputs": [
        1
      ]
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "duration": "text",
    "deletedAt": "2025-02-21T15:47:01.250Z",
    "createdAt": "2025-02-21T15:47:01.250Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": "text",
    "errorMessage": "text",
    "description": "text",
    "taskTimeout": 1,
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-02-21T15:47:01.250Z"
    }
  }
}

A successful response.

Get info about a data source

Get info about a data source

post

/datasource/info

Authorizations
Body
dataSourceobject

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

listFilesboolean
Responses
curl -L \
  --request POST \
  --url 'https://api.bytenite.com/v1/customer/datasource/info' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"dataSource":{"dataSourceDescriptor":"s3","params":{"ANY_ADDITIONAL_PROPERTY":"anything"}}}'
{
  "filename": "text",
  "path": "text",
  "size": "text",
  "tempUrl": "text",
  "files": {
    "name": "text",
    "path": "text",
    "directories": [
      {
        "name": "text",
        "path": "text",
        "directories": [
          {
            "name": "text",
            "path": "text",
            "directories": "[Circular Reference]",
            "files": [
              {
                "id": "text",
                "name": "text",
                "path": "text",
                "size": "text"
              }
            ]
          }
        ],
        "files": [
          {
            "id": "text",
            "name": "text",
            "path": "text",
            "size": "text"
          }
        ]
      }
    ],
    "files": [
      {
        "id": "text",
        "name": "text",
        "path": "text",
        "size": "text"
      }
    ]
  },
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

A successful response.

PreviousJobsNextParams

Last updated

Was this helpful?