Batch API

Create Batch (POST)

Create a batch with a list of unique part names.

Form Data
ParameterDescriptionRequiredTypeValid ValuesDefault Value
nameName of the batch.falsestring1-250<owner name> <current date: %d_%m_%Y_%H_%M_%S>
sizeSize of the batchfalseintegerx >= 11
Return Data
{
    'name': 'my_batch_1',
    'batch_pk': 1,
    'size': 4
}
Errors
PreconditionStatus codeError message
The given batch name is smaller equals 150 characters long.422Parameter ‘name’ cannot be longer than 250 characters.
The given batch is either empty or at least 1 character long.422Parameter ‘name’ has must be at least 1 characters long.
The given size must be either blank or aninteger.422Parameter ‘size: 1.0 invalid. Must be an integer.
The given size must be at least 1 if given.422Parameter ‘size: 0 must be greater or equals than 1.
Usage
# POST "https://platform.3dspark.de/api/v1//api/v1/batch/"

let formData = {
  "name": "my_batch_1",
  "size": 4,
}
this.axiosInstance
  .put("/api/v1/api/v1/batch/", formData)
  .then((response) => {
    console.log(response.data);
    let batch_pk = response.data.batch_pk
    // for part upload see part_api create part (set batch_pk)
  })

Get BatchDropdown (GET)

Get all batches from given user filtered option by name.

Form Data
ParameterDescriptionRequiredTypeValid Values
namefilters by a case insensitive batch name.falsestring1-250
Return Data
[
  {
    "pk": 1,
    "name": "my_batch_1",
  },
  {
    "pk": 1,
    "name": "my_batch_2",
  }
]
Errors
PreconditionStatus codeError message
The given batch name is smaller equals 150 characters long.422Parameter ‘name’ cannot be longer than 250 characters.

get Batch (GET)

Get the batch for the given batch_pk

Return Data
{
  'batch_pk': 1,
  'batch_name': 'my_batch',
  'parts': ['5f2d64ec-031d-494e-9c0c-a472523a5db0', ...],
  "size": 4,
  "created": "30_10_1991_4_20_55",
  "updated": "30_10_1991_4_20_55"}
Errors
PreconditionStatus codeError message
The batch_pk given in the url.422Parameter ‘batch_pk’ missing in url.
The batch_pk given in the url is an integer.422Parameter ‘batch_pk: 3.2’ invalid. Must be an integer.
The batch_pk given in the url is greater then zero.422Parameter ‘batch_pk: 0’ must be greater than 0.
Usage
# GET "https://platform.3dspark.de/api/v1/batch-dropdown/"
let formData = {
  "name": "my_batch",
}
this.axiosInstance
  .get("/api/v1/batch-dropdown/")
  .then((response) => {
    for(let i = 0; i < response.data.length; ++i){
      batch = response.data[i]
      this.axiosInstance
        # GET "https://platform.3dspark.de/api/v1/batch/1/"
        .get(f"/api/v1/batch/{batch.pk}/")
        .then((inner_response) => {
          console.log(inner_response.data);
        })
    }
  })