GET api/Note/GetOpportunityFilesList?opportunityId={opportunityId}&folderId={folderId}
Opportunity files/folders list endpoint.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
opportunityId |
Database ID of a opportunity. |
globally unique identifier |
Required |
folderId |
Database ID of subfolder. Optional parameter that you may pass to get a list of files from opportunity files subfolder. |
globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
List of files and folders from opportunity files folder.
NowCertsApiResultOfNoteFilesListName | Description | Type | Additional information |
---|---|---|---|
Status | ApiStatus |
None. |
|
Data | NoteFilesList |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "status": 0, "data": { "files": [ { "databaseId": "6be5d4da-423d-4cf4-8595-370f53473780", "name": "sample string 2", "path": "sample string 3", "downloadUrl": "sample string 4", "downloadUrlExpiresAtUtc": "2024-12-10T08:16:33.402693-06:00", "type": 0, "mime": "sample string 5", "size": 6, "createDate": "2024-12-10T08:16:33.402693-06:00", "changeDate": "2024-12-10T08:16:33.402693-06:00", "creatorName": "sample string 9", "isInsuredVisibleFolder": true, "fileOrFolder": "sample string 11" }, { "databaseId": "6be5d4da-423d-4cf4-8595-370f53473780", "name": "sample string 2", "path": "sample string 3", "downloadUrl": "sample string 4", "downloadUrlExpiresAtUtc": "2024-12-10T08:16:33.402693-06:00", "type": 0, "mime": "sample string 5", "size": 6, "createDate": "2024-12-10T08:16:33.402693-06:00", "changeDate": "2024-12-10T08:16:33.402693-06:00", "creatorName": "sample string 9", "isInsuredVisibleFolder": true, "fileOrFolder": "sample string 11" } ], "currentFolderId": "db1ac92e-f894-43e4-bc43-b8d89197f811" }, "message": "sample string 1" }
application/xml, text/xml
Sample:
<NowCertsApiResultOfNoteFilesListodPQ2rGR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum"> <Data> <CurrentFolderId>db1ac92e-f894-43e4-bc43-b8d89197f811</CurrentFolderId> <Files> <FileList> <ChangeDate>2024-12-10T08:16:33.402693-06:00</ChangeDate> <CreateDate>2024-12-10T08:16:33.402693-06:00</CreateDate> <CreatorName>sample string 9</CreatorName> <DatabaseId>6be5d4da-423d-4cf4-8595-370f53473780</DatabaseId> <DownloadUrl>sample string 4</DownloadUrl> <DownloadUrlExpiresAtUtc>2024-12-10T08:16:33.402693-06:00</DownloadUrlExpiresAtUtc> <FileOrFolder>sample string 11</FileOrFolder> <IsInsuredVisibleFolder>true</IsInsuredVisibleFolder> <MIME>sample string 5</MIME> <Name>sample string 2</Name> <Path>sample string 3</Path> <Size>6</Size> <Type>File</Type> </FileList> <FileList> <ChangeDate>2024-12-10T08:16:33.402693-06:00</ChangeDate> <CreateDate>2024-12-10T08:16:33.402693-06:00</CreateDate> <CreatorName>sample string 9</CreatorName> <DatabaseId>6be5d4da-423d-4cf4-8595-370f53473780</DatabaseId> <DownloadUrl>sample string 4</DownloadUrl> <DownloadUrlExpiresAtUtc>2024-12-10T08:16:33.402693-06:00</DownloadUrlExpiresAtUtc> <FileOrFolder>sample string 11</FileOrFolder> <IsInsuredVisibleFolder>true</IsInsuredVisibleFolder> <MIME>sample string 5</MIME> <Name>sample string 2</Name> <Path>sample string 3</Path> <Size>6</Size> <Type>File</Type> </FileList> </Files> </Data> <Message>sample string 1</Message> <Status>Error</Status> </NowCertsApiResultOfNoteFilesListodPQ2rGR>