Create File Upload Session

POST 
/api/v1/file-upload-session

File Upload Session

Request

application/json

Body

fileName stringrequired

Possible values: non-empty

Unique identifier of the file to be uploaded. File name must be unique for the organization.

Responses

201

Created

application/json

Schema

Schema

data

object

expiryTime date-time

Time until the link is valid.

uploadSession string

Possible values: non-empty

URL to upload the file to File Management System.

Example (from schema)

{
  "data": {
    "expiryTime": "2022-06-22T10:03:00.183881+00:00",
    "uploadSession": "https://mock.url"
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...