Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel7
minLevel1

POST /files

Parameters

Parameter

Type

Description

file

Binary

File content

meta.category

String

File category. This is to mark the usage of the attachments. For now the possible reasons are 'intake_attachment', 'user_consent', 'user_avatar', 'user_document'

...

Parameter

Type

Description

target_id

String

The id of the target which is related to the files

target_type

String

The file of the target which is related to the files. For now the possible values are 'user' and 'visit'

category_type

String

The category type of this file. For now the possible reasons are 'user_document', 'intake_attachment', 'user_consent', 'user_avatar'.

include_shared

Boolean true|false

Include this param will get all the files that tagged user_document and notes files that shared to the user.

Response

Code Block
curl -X GET \
>   'https://api.vsee.io/cc/ligeng/api_v3/files?target_id=350936&target_type=user' \
>   -H 'X-ApiToken: 4df5b2b7dec8a8c40e142e43c1825502' \
>   -H 'cache-control: no-cache' \
>   -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
>   -F target_id=350936 \
>   -F target_type=user


{
    "data": [
        {
            "id": "5e1598e7-4118-47ca-84da-0923c71b6977",
            "name": "55bb223fd7304.jpg",
            "size": 184259,
            "ext": "jpg",
            "fullpath": "https:\/\/api.vsee.io\/cc\/ligeng\/files\/view\/5e1598e7-4118-47ca-84da-0923c71b6977?auth_code=ede418b2b0b1fa5451c726a7e6959b2efabcad97&time=1578530083",
            "creator": {
                "username": "ligeng+trial14+member01@vseelab.com",
                "type": 200,
                "full_name": "Ligeng Long Long Long Long Long Long Long Long Long Long Long Long Long Long Long Name"
            },
            "is_deletable": false, // true if attachment type is user_document
            "created": 1578473704
        }
    ]
}

...