Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • A api
  • Project information
    • Project information
    • Activity
    • Members
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Wiki
    • Wiki
  • Activity
Collapse sidebar
  • ironapi
  • api
  • Wiki
  • Api
  • Storing Files

Storing Files · Changes

Page history
Update Storing Files authored Dec 03, 2021 by Andrea Pavlovic's avatar Andrea Pavlovic
Show whitespace changes
Inline Side-by-side
API/Storing-Files.md
View page @ 6befce20
# Storing Files # Storing Files
## Concept
The concept to having files saved in the database is that any attribute may be defined as a file. The concept to having files saved in the database is that any attribute may be defined as a file.
```xml ```xml
...@@ -28,6 +30,8 @@ In the universe, an attribute can be identified as being a file by it's baseData ...@@ -28,6 +30,8 @@ In the universe, an attribute can be identified as being a file by it's baseData
The attribute's permissions are handled as usual - if it's available in a transition, it may be set. The attribute's permissions are handled as usual - if it's available in a transition, it may be set.
## Upload
To set (upload) a file, it needs to be packed into the json request of any transition which includes it. To set (upload) a file, it needs to be packed into the json request of any transition which includes it.
The attribute must be set to the original file name and the base64 encoded file data, seperated by a semi-colon: The attribute must be set to the original file name and the base64 encoded file data, seperated by a semi-colon:
...@@ -63,8 +67,12 @@ As seen in the reply, the attribute will be replaced with meta data needed to st ...@@ -63,8 +67,12 @@ As seen in the reply, the attribute will be replaced with meta data needed to st
} }
``` ```
## Download
As stated in the universe, the file itself can be downloaded via a seperate url: As stated in the universe, the file itself can be downloaded via a seperate url:
**
/data/helpdesk/ticket/3/download/attachment** "3" being the ID of the instance, "attachment" the name of the attribute the file is stored in:
GET /data/helpdesk/ticket/3/download/attachment
Permission to do so will be the same as a permission to view the instance. Permission to do so will be the same as a permission to view the instance.
\ No newline at end of file
Clone repository
  • API
    • Available Endpoints
    • Changing Passwords
    • Form Input Types
    • Introduction
    • Logout
    • Plugins
    • Queries
    • Queries
      • Attributes
      • Context
      • Query Examples
      • Query Search Options
      • Referenced Instances
      • Saved Queries
    • Schema_Changes
    • Storing Files
View All Pages