Documents

File a report

File a report as a PDF document to a document collection, optionally under a folder

post/api/v1/documents/file

Request

  • Base URL: /sandbox (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /sandbox/api/v1/documents/file
  • Auth: OAuth 2 (authorization code, authorization URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/authorize, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token; client credentials, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token, scopes: tenant-user, policy.write)

Query parameters

collectionstring required

e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c

reportIdstring required

The report id PDF and file

fileNamestring

File the report with this file name, or use a random name

folderstring

e.g. documentfolder_c0645dc026a74ae99ec436df63d77d2c

The folder to file it to, or the root folder if not specified

Response

OK

successboolean
reasonstring nullable
resultCode0 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110

Represents the outcome of a command execution. Used to indicate success or the reason for failure when a command does not succeed.

sourceIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.