Upload Files

POST 
/entities/{entity-id}/files

Uploads files for later use.

Request

Path Parameters

entity-id stringrequired

Entity Id

application/json

Body

required

file

object

required

BaseFile

name string

data string

Responses

201

OK

application/json

Schema

Schema

file

object

FileUploaded

correlationId Id (string)

Id

name string

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

file

object

FileUploaded

correlationId Id (string)

Id

name string

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

file

object

FileUploaded

correlationId Id (string)

Id

name string

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

file

object

FileUploaded

correlationId Id (string)

Id

name string

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

404

Not Found

application/json

Schema

Schema

file

object

FileUploaded

correlationId Id (string)

Id

name string

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

file

object

FileUploaded

correlationId Id (string)

Id

name string

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

Loading...