API docs by Redocly

Aptic API Gateway - Document and file archive (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Document and file archive API for Aptic solutions

Archive

Downloads an archived document using document GUID

Authorizations:
(oauth2apikey)
path Parameters
documentGuid
required
string

Document unique id

Responses

Response samples

Content type
No sample

Uploads a document for archiving using a prepared document GUID

Authorizations:
(oauth2apikey)
path Parameters
documentGuid
required
string

Document unique id

Responses

Response samples

Content type
No sample

Files

Get list of all files in selected directory

Authorizations:
(oauth2apikey)
path Parameters
directoryName
required
string

Name of the directory

Responses

Response samples

Content type
No sample

Uploads a file to specified folder

Authorizations:
(oauth2apikey)
path Parameters
directoryName
required
string

Name of the directory

Request Body schema:
file
string <binary>

File to be uploaded

Responses

Response samples

Content type
No sample

Download specified file from selected directory

Authorizations:
(oauth2apikey)
path Parameters
directoryName
required
string

Name of the directory

fileName
required
string

Name of the file

Responses

Response samples

Content type
No sample

Uploads a file to specified folder and with specified name

Authorizations:
(oauth2apikey)
path Parameters
directoryName
required
string

Name of the directory

fileName
required
string

Name of the file

Request Body schema:
file
string <binary>

File to be uploaded

Responses

Response samples

Content type
No sample

Downloads an exported file using the file GUID

Authorizations:
(oauth2apikey)
path Parameters
fileGuid
required
string

File unique id

Responses

Response samples

Content type
No sample

Repository

Download specified object file from repository. Typically logo or user images. The parameter can be either a user or a client/party guid. To return the file contents as base64 encoded json, you can either provide the json parameter in the query, or pass "application/json" in the Accept header.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

User or client/party guid of file to download from the repository

query Parameters
json
boolean

Set to true if you want the result as base64 encapsulated in json

Responses

Response samples

Content type
No sample