Files

Endpoints

 

StoredFilesApi

For storing files.

/api/StoredFilesApi

/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

/api/StoredFilesContentApi

Operation

Logged in User

Parameters

Body

Response

GET
Retrieve stored file content only.

 

storedFileId *

 

 

 

UploadFileApi

For uploading files.

/api/UploadFileApi

/api/UploadFileApi

Operation

Logged in User

Parameters

Body

Response

POST

 

fileName
fileUrl
relatedRecordId *
relatedRecordType*

 

 

 

Models

 

Inline Model

Property

Data Type

Description

Property

Data Type

Description

StoredFileId

Integer

Stored file id.

Back to top

 

StoredFilesApiKey

Property

Data Type

Description

Property

Data Type

Description

StoredFileId

Integer

Stored file id.

Back to top

 

StoredFilesApiModel

Property

Data Type

Description

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

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

Request

Response

Response sample

Top of page