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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "file": {
    "correlationId": "string",
    "name": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Loading...