Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Endpoints

StoredFilesApi

For storing files.

/api/StoredFilesApi

Operation

Logged in User

Parameters

Body

Response

DELETE
Mark StoredFile as deleted.

storedFileId *

GET
Retrieve stored file metadata information.

storedFileId *

POST
Requires multipart/form-data content. Consist of two parts: application/* - any file and application/json - File Metadata

StoredFilesContentApi

For Retrieve stored file content only.

/api/StoredFilesContentApi

Operation

Logged in User

Parameters

Body

Response

GET
Retrieve stored file content only.

storedFileId *

UploadFileApi

For uploading files.

/api/UploadFileApi

Operation

Logged in User

Parameters

Body

Response

POST

fileName
fileUrl
relatedRecordId *
relatedRecordType*

Models

Inline Model

Property

Data Type

Description

StoredFileId

Integer

Stored file id.

⬆️ Back to top

StoredFilesApiKey

Property

Data Type

Description

StoredFileId

Integer

Stored file id.

⬆️ Back to top

StoredFilesApiModel

Property

Data Type

Description

Key

StoredFilesApiKey

RelatedRecord

String

RelatedRecordId

String

FileGroupId

Integer

Details

String

FileName

String

Url

String

ImageDocument

Boolean

SecondaryPath

String

KeyStr

String

KeyDate

String

KeyInt

Integer

⬆️ Back to top

UploadedFileApiModel

Property

Data Type

Description

FileName

String

File name.

FileExtension

String

File extension.

ContentType

String

RelatedRecordId

String

Related records.

RelatedRecordType

String

Related records type.

StoredFileId

Integer

Stored file id.

⬆️ Back to top

Example

%Title

 Click to view

Request

Response

Response sample

⬆️ Top of page

  • No labels