GET api/RelatedFile?moduleType={moduleType}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| moduleType | RelatedFileModuleTypeEnum |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of StorageViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| CompanyId | integer |
None. |
|
| CompanyUniqueId | globally unique identifier |
None. |
|
| UniqueId | globally unique identifier |
None. |
|
| JobUid | globally unique identifier |
None. |
|
| ClientUid | globally unique identifier |
None. |
|
| ProjectKeyUid | globally unique identifier |
None. |
|
| StorageCategoryId | integer |
None. |
|
| FileName | string |
None. |
|
| Filesize | integer |
None. |
|
| UniqueFileName | string |
None. |
|
| Description | string |
None. |
|
| IsExist | boolean |
None. |
|
| FolderId | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"id": 1,
"companyId": 2,
"companyUniqueId": "29de3f9a-f5e0-4e92-84c2-6f58b2ad4cbc",
"uniqueId": "deab0339-e275-4733-946b-7b172a112693",
"jobUid": "cc4ce23d-d0de-4a1e-b24b-58824876e3f8",
"clientUid": "5420f51b-4a02-45d9-b8f0-e03635271305",
"projectKeyUid": "07109385-9a3c-44b7-ae2c-3939d320d724",
"storageCategoryId": 1,
"fileName": "sample string 5",
"filesize": 6,
"uniqueFileName": "sample string 7",
"description": "sample string 8",
"isExist": true,
"folderId": 1
},
{
"id": 1,
"companyId": 2,
"companyUniqueId": "29de3f9a-f5e0-4e92-84c2-6f58b2ad4cbc",
"uniqueId": "deab0339-e275-4733-946b-7b172a112693",
"jobUid": "cc4ce23d-d0de-4a1e-b24b-58824876e3f8",
"clientUid": "5420f51b-4a02-45d9-b8f0-e03635271305",
"projectKeyUid": "07109385-9a3c-44b7-ae2c-3939d320d724",
"storageCategoryId": 1,
"fileName": "sample string 5",
"filesize": 6,
"uniqueFileName": "sample string 7",
"description": "sample string 8",
"isExist": true,
"folderId": 1
}
]
application/xml, text/xml
Sample:
<ArrayOfStorageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<StorageViewModel>
<ClientUid>5420f51b-4a02-45d9-b8f0-e03635271305</ClientUid>
<CompanyId>2</CompanyId>
<CompanyUniqueId>29de3f9a-f5e0-4e92-84c2-6f58b2ad4cbc</CompanyUniqueId>
<Description>sample string 8</Description>
<FileName>sample string 5</FileName>
<Filesize>6</Filesize>
<FolderId>1</FolderId>
<Id>1</Id>
<IsExist>true</IsExist>
<JobUid>cc4ce23d-d0de-4a1e-b24b-58824876e3f8</JobUid>
<ProjectKeyUid>07109385-9a3c-44b7-ae2c-3939d320d724</ProjectKeyUid>
<StorageCategoryId>1</StorageCategoryId>
<UniqueFileName>sample string 7</UniqueFileName>
<UniqueId>deab0339-e275-4733-946b-7b172a112693</UniqueId>
</StorageViewModel>
<StorageViewModel>
<ClientUid>5420f51b-4a02-45d9-b8f0-e03635271305</ClientUid>
<CompanyId>2</CompanyId>
<CompanyUniqueId>29de3f9a-f5e0-4e92-84c2-6f58b2ad4cbc</CompanyUniqueId>
<Description>sample string 8</Description>
<FileName>sample string 5</FileName>
<Filesize>6</Filesize>
<FolderId>1</FolderId>
<Id>1</Id>
<IsExist>true</IsExist>
<JobUid>cc4ce23d-d0de-4a1e-b24b-58824876e3f8</JobUid>
<ProjectKeyUid>07109385-9a3c-44b7-ae2c-3939d320d724</ProjectKeyUid>
<StorageCategoryId>1</StorageCategoryId>
<UniqueFileName>sample string 7</UniqueFileName>
<UniqueId>deab0339-e275-4733-946b-7b172a112693</UniqueId>
</StorageViewModel>
</ArrayOfStorageViewModel>