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	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": "ab41b071-ce58-4e79-b3d4-d34584df0171",
    "uniqueId": "73c36df6-5ae9-4ac5-82f4-51999ea78fd8",
    "jobUid": "63239798-24d2-4aa6-8056-e5d6f7e3c2a6",
    "clientUid": "6b9242cf-82e0-4f4e-9d6b-839d5d1cce4e",
    "projectKeyUid": "6efb2ff4-1cf2-4777-9ea4-5ea8590e24d3",
    "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": "ab41b071-ce58-4e79-b3d4-d34584df0171",
    "uniqueId": "73c36df6-5ae9-4ac5-82f4-51999ea78fd8",
    "jobUid": "63239798-24d2-4aa6-8056-e5d6f7e3c2a6",
    "clientUid": "6b9242cf-82e0-4f4e-9d6b-839d5d1cce4e",
    "projectKeyUid": "6efb2ff4-1cf2-4777-9ea4-5ea8590e24d3",
    "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>6b9242cf-82e0-4f4e-9d6b-839d5d1cce4e</ClientUid>
    <CompanyId>2</CompanyId>
    <CompanyUniqueId>ab41b071-ce58-4e79-b3d4-d34584df0171</CompanyUniqueId>
    <Description>sample string 8</Description>
    <FileName>sample string 5</FileName>
    <Filesize>6</Filesize>
    <FolderId>1</FolderId>
    <Id>1</Id>
    <IsExist>true</IsExist>
    <JobUid>63239798-24d2-4aa6-8056-e5d6f7e3c2a6</JobUid>
    <ProjectKeyUid>6efb2ff4-1cf2-4777-9ea4-5ea8590e24d3</ProjectKeyUid>
    <StorageCategoryId>1</StorageCategoryId>
    <UniqueFileName>sample string 7</UniqueFileName>
    <UniqueId>73c36df6-5ae9-4ac5-82f4-51999ea78fd8</UniqueId>
  </StorageViewModel>
  <StorageViewModel>
    <ClientUid>6b9242cf-82e0-4f4e-9d6b-839d5d1cce4e</ClientUid>
    <CompanyId>2</CompanyId>
    <CompanyUniqueId>ab41b071-ce58-4e79-b3d4-d34584df0171</CompanyUniqueId>
    <Description>sample string 8</Description>
    <FileName>sample string 5</FileName>
    <Filesize>6</Filesize>
    <FolderId>1</FolderId>
    <Id>1</Id>
    <IsExist>true</IsExist>
    <JobUid>63239798-24d2-4aa6-8056-e5d6f7e3c2a6</JobUid>
    <ProjectKeyUid>6efb2ff4-1cf2-4777-9ea4-5ea8590e24d3</ProjectKeyUid>
    <StorageCategoryId>1</StorageCategoryId>
    <UniqueFileName>sample string 7</UniqueFileName>
    <UniqueId>73c36df6-5ae9-4ac5-82f4-51999ea78fd8</UniqueId>
  </StorageViewModel>
</ArrayOfStorageViewModel>