Delete A File/ Multiple Files

DELETE /api/v1/{entity-type}/{entity-id}/{property}/documents/{document-id}

Path Parameters

NameTypeDescription

entity-type*

String

Entity type for which the template will be uploaded

entity-id*

String

Entity ID for mentioned Entity Type

property*

String

any String for eg templates for uploading html template

document-id

String

ID of document that was uploaded. If this is not provided, entire directory that holds any no of files will be deleted

Headers

NameTypeDescription

authorization

String

Set to Bearer {access-token} if roles in schema is not anonymous. Else authorization can be empty

Usage

cURL

curl --location \
    --request DELETE '{registry-url}/api/v1/{entity-type/{entity-id}/{property}/documents/{document-id}' \
    --header 'Authorization: Bearer {access-token}'

HTTPie

http DELETE '{registry-url}/api/v1/{entity-type/{entity-id}/{property}/documents/{document-id}' \
 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 updated

Copyright (c) 2023 EkStep Foundation under MIT License