Upload A File

POST /api/v1/{entity-type}/{entity-id}/{property}/documents

Path Parameters

Name	Type	Description
entity-type*	String	Entity type for which the template will be uploaded
entity-id*	String	Entity ID for mentioned Entity Type

Headers

Name	Type	Description
content-type*	String	Set to multipart/form-data
authorization	String	Set to Bearer {access-token} if roles in schema config is not anonymous else this can be empty

Request Body

Name	Type	Description
files*	Object	files is template-key which can be replaced with your choice. Requires a html file to be sent which will be uploaded

200: OK Success Response of File uploaded

{
    "documentLocations": [
        "{url}"
    ],
    "errors": []
}

Usage

cURL

curl --location \
    --header 'Authorization: {access-token}' \
    --form 'files=@"{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.