ProcFormFile(
    int  FileID,
    bool ReturnDownloadUrl
    string AlternateID
)

Returns the information for a File.

Request

Request Data:

  • (int) FileID (required) – identify the file to get.
  • (bool) ReturnDownloadUrl (required) – if true the response will not contain the “File” property and instead returns a “DownloadUrl” with a temporary download link for the file.
    Notes: The URL is valid for 5 minutes (Available since RPM24)
  • (string) AlternateID (optional, required if FileID is not provided)

File ID example:

{
    "FileID": <int>
}

Alternate ID example:

{
    "AlternateID": <string>
}

Response

{
  "Result": {
    "FileID": <int>,
    "FormID": <int>,
    "File": <string>, // Base64 data without the data-uri prefix (data:[<media type>][;base64])
    "DownloadUrl": <string>, // Valid for 5 minutes. Since RPM24
    "Name": <string>,
    "Description": <string>,
    "IsStaffOnly": <bool>,
    "FolderID": <int>
  }
}

Errors

  • “File not found”
  • “Form not found”
  • "Permission denied"