GET api/Note/GetOpportunityFilesList?opportunityId={opportunityId}&folderId={folderId}

Opportunity files/folders list endpoint.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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.

NowCertsApiResultOfNoteFilesList
NameDescriptionTypeAdditional information
Status

ApiStatus

None.
Data

NoteFilesList

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "status": 0,
  "data": {
    "files": [
      {
        "databaseId": "969cfbe3-b482-4ef2-a294-dfe75469b9cb",
        "name": "sample string 2",
        "path": "sample string 3",
        "downloadUrl": "sample string 4",
        "downloadUrlExpiresAtUtc": "2024-11-21T03:08:09.6195484-06:00",
        "type": 0,
        "mime": "sample string 5",
        "size": 6,
        "createDate": "2024-11-21T03:08:09.6195484-06:00",
        "changeDate": "2024-11-21T03:08:09.6195484-06:00",
        "creatorName": "sample string 9",
        "isInsuredVisibleFolder": true,
        "fileOrFolder": "sample string 11"
      },
      {
        "databaseId": "969cfbe3-b482-4ef2-a294-dfe75469b9cb",
        "name": "sample string 2",
        "path": "sample string 3",
        "downloadUrl": "sample string 4",
        "downloadUrlExpiresAtUtc": "2024-11-21T03:08:09.6195484-06:00",
        "type": 0,
        "mime": "sample string 5",
        "size": 6,
        "createDate": "2024-11-21T03:08:09.6195484-06:00",
        "changeDate": "2024-11-21T03:08:09.6195484-06:00",
        "creatorName": "sample string 9",
        "isInsuredVisibleFolder": true,
        "fileOrFolder": "sample string 11"
      }
    ],
    "currentFolderId": "1b6c5064-1e43-44ec-a179-77c682185b3d"
  },
  "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>1b6c5064-1e43-44ec-a179-77c682185b3d</CurrentFolderId>
    <Files>
      <FileList>
        <ChangeDate>2024-11-21T03:08:09.6195484-06:00</ChangeDate>
        <CreateDate>2024-11-21T03:08:09.6195484-06:00</CreateDate>
        <CreatorName>sample string 9</CreatorName>
        <DatabaseId>969cfbe3-b482-4ef2-a294-dfe75469b9cb</DatabaseId>
        <DownloadUrl>sample string 4</DownloadUrl>
        <DownloadUrlExpiresAtUtc>2024-11-21T03:08:09.6195484-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-11-21T03:08:09.6195484-06:00</ChangeDate>
        <CreateDate>2024-11-21T03:08:09.6195484-06:00</CreateDate>
        <CreatorName>sample string 9</CreatorName>
        <DatabaseId>969cfbe3-b482-4ef2-a294-dfe75469b9cb</DatabaseId>
        <DownloadUrl>sample string 4</DownloadUrl>
        <DownloadUrlExpiresAtUtc>2024-11-21T03:08:09.6195484-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>