Upload File

POST 
/signed-upload/:session_id

Upload File

Request

Path Parameters

session_id stringrequired

multipart/form-data

Body

file binaryrequired

Responses

201

File uploaded

application/json

Schema

Schema

data

object

contentType stringrequired

ContentType of the file

createdAt string

Uploaded Time

createdBy stringrequired

User Id who upload the file

dataSource stringrequired

Source of uploaded file

extension stringrequired

Extension of the file

fileId stringrequired

Unique identifier of the file.

fileName stringrequired

Name of the uploaded file (final name).

fileSize integerrequired

File size in bytes

fullHashSum stringrequired

MD5 sum

lightHashSum stringrequired

MD5 sum by first 2048 bytes

orgId stringrequired

Org Id of the file

originalExtension stringrequired

Original extension of the file

originalName stringrequired

Original name of the uploaded file.

product stringrequired

Possible values: [sight, rise, tracking]

Name of the product

storage

object

current stringrequired

Storage type

path stringrequired

Relative path to the file

ttl integer

Expiration time

storageName stringrequired

Relative path of the file in our storage

updatedAt string

Updated Time

updatedBy stringrequired

User Id who upload the file

userId stringrequired

User Id who upload the file

Example (from schema)

{
  "data": {
    "contentType": "ms-application/excel",
    "createdAt": "2022-07-25T09:46:12+00:00",
    "createdBy": "uuuu",
    "dataSource": "integration-api",
    "extension": "xls",
    "fileId": "ef9cd482-596d-7a5d-8155-137463f056fd",
    "fileName": "ab8cd482-596d-7a5d-8155-137463f243ac.xls",
    "fileSize": "100500",
    "fullHashSum": "C9025CC0FD86FF0A2B6B53AF58ACDE1B",
    "lightHashSum": "C9025CC0FD86FF0A2B6B53AF58ACDE1B",
    "orgId": "xxxx",
    "originalExtension": "xls",
    "originalName": "original file name",
    "product": "sight",
    "storage": {
      "current": "standard",
      "path": "/sight/xxxx/uuuu/ab8cd482-596d-7a5d-8155-137463f243ac.xls",
      "ttl": 0
    },
    "storageName": "/sight/xxxx/uuuu/ab8cd482-596d-7a5d-8155-137463f243ac.xls",
    "updatedAt": "2022-07-25T09:46:12+00:00",
    "updatedBy": "uuuu",
    "userId": "uuuu"
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

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

500

Internal server 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...