Upload A File

post
 
/api/v1/{entity-type}/{entity-id}/{property}/documents
Parameters
Path
entity-type*
Entity type for which the template will be uploaded
entity-id*
Entity ID for mentioned Entity Type
Header
content-type*
Set to multipart/form-data
authorization
Set to Bearer {access-token} if roles in schema config is not anonymous else this can be empty
Body
files*
Object
files is template-key which can be replaced with your choice. Requires a html file to be sent which will be uploaded
Responses
200: OK
Success Response of File uploaded
​
Usage
cURL
curl --location \
    --header 'Authorization: {access-token}' \
    --form '[email protected]"{file-path}"'
    --request POST 
    '{registry-url}/api/v1/{entity-type}/{entity-id}/{property}/documents' \
HTTPie
http --ignore-stdin \
    --form POST \
    '{registry-url}/api/v1/{entity-type}/{entity-id}/{property}/documents' \
 'files'@{file-path} \
 Authorization:'Bearer {access-token}' \
{registry-url} is usually http://localhost:{port}. The port can be found under the registry section in the docker-compose.yml file and is usually 8081.

Last modified 6mo ago