Upload a file

Updated on 30 Apr 2020

Description

A User or External Entity on behalf of a User with role permission MEDIA_FILE_OWNER will go through all steps of “Authentication” Use Case, and then send a request to Endpoint “Upload a file”.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with permissions: MEDIA_FILE_OWNER.
  2. System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.

Preconditions

  1. The user must have a System Operator profile with sufficient access privileges.

Basic Flow

By default, this flow assumes that External Entity sends Requests to System Operator Endpoints, and System Operator sends back Responses to External Entity.

  1. Perform all steps of Use Case “Authentication”.
  2. External Entity sends a request to Endpoint “Upload a file”.

API endpoint: https://sdkfinance.app/api/ui/#!/Media_files_management/upload

Parameters:

Authorization – authorization token

file – file to be uploaded

  1. System Operator returns complete file information to External Entity. (See Result example below)

Optional Flow with Web Browser UI

  1. Perform all steps of Use Case “Authentication”.
  2. A user sends a request to Endpoint “Upload a file”.

API endpoint: https://sdkfinance.app/api/ui/#!/Media_files_management/upload

Parameters:

Authorization – authorization token

file – file to be uploaded

  1. System Operator returns complete file information to User (See Result example below).

Post Conditions

File uploaded and complete file information is available.

Result example



   "file":{ 

      "id":"string",

      "ownerId":"string",

      "mediaType":"string",

      "name":"string",

      "url":"string",

      "md5":"string",

      "sha1":"string",

      "size":0,

      "used":false,

      "createdAt":"2018-08-16T14:36:20.969Z",

      "expiresAt":"2018-08-16T14:36:20.969Z",

      "tag":"string"

   },

   "status":"ok",

   "message":"string"

}