project

v1

POST /api/v1/project/upload-session/{uid}/_batch_upload/

Changed on Sep 22, 2021

Upload batch of files

Params:
    - folder (source_path): str - absolute path to a directory containing files
    - force: bool (optional) - whether rewrite existing file and Document

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/project/upload-session/:uid/_batch_upload/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

uidstring required

A UUID string identifying this upload session.

Request body

uidstring uuid

projectinteger nullable

created_datestring date-time

document_typestring

progressstring

completedboolean nullable

is_cancelingstring

Example request

{
  "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "is_canceling": "is_canceling",
  "project": 0,
  "progress": "progress",
  "created_date": "2000-01-23T04:56:07.000+00:00",
  "completed": true,
  "created_by": {
    "pk": 2,
    "username": "username"
  },
  "document_type": "document_type"
}

Response

uidstring uuid

projectinteger nullable

created_datestring date-time

document_typestring

progressstring

completedboolean nullable

is_cancelingstring

Example response

{
  "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "is_canceling": "is_canceling",
  "project": 0,
  "progress": "progress",
  "created_date": "2000-01-23T04:56:07.000+00:00",
  "completed": true,
  "created_by": {
    "pk": 2,
    "username": "username"
  },
  "document_type": "document_type"
}

Changes

Sep 22, 202163116f2e9e3e Revision changes
- info
  added the optional property to the response with the status
May 24, 20218167164be9cc Revision changes
- breaking
  the request property type changed from object to integer (media type: application/json)
- breaking
  the request property type changed from object to integer (media type: application/x-www-form-urlencoded)
- breaking
  the request property type changed from object to integer (media type: multipart/form-data)
- breaking
  the response property became nullable for the status
- breaking
  the response's property type changed from object to integer for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the request property / (media type: application/json)
- warning
  removed the request property / (media type: application/x-www-form-urlencoded)
- warning
  removed the request property / (media type: multipart/form-data)
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: application/x-www-form-urlencoded)
- info
  added the new optional request property (media type: multipart/form-data)
- info
  the request property became nullable (media type: application/json)
- info
  the request property became nullable (media type: application/x-www-form-urlencoded)
- info
  the request property became nullable (media type: multipart/form-data)
- info
  added the optional property to the response with the status

Operation history (3 revisions)