Sign in
Reports

Create or update a report by publicId

put/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}

Path parameters

deploymentIdnumber required
publicIdstring required

Request body

endResultCellstring nullable
externalWorkbookIdstring nullable
folderIdinteger nullable
host'GOOGLE_SHEETS' | 'EXCEL'
jsonQuerystring nullable
metaobject nullable
namestring nullable
publicIdstring nullable
resultLocationstring nullable
sheetIdstring nullable
source'GOOGLE_SHEETS' | 'EXCEL' | 'PLAYGROUND' | 'D3'
sqlQuerystring nullable
titlestring nullable
workbookIdinteger nullable
workbookNamestring nullable

Response

canEditboolean nullable
canManageboolean nullable
createdByinteger
currentQueryChecksumstring nullable
deploymentIdinteger required
descriptionstring nullable
endResultCellstring nullable
externalWorkbookIdstring nullable
folderIdinteger nullable
idinteger required
jsonQuerystring nullable
metaobject nullable
namestring required
publicIdstring required
refreshedByinteger nullable
resultLocationstring nullable
source'GOOGLE_SHEETS' | 'EXCEL' | 'PLAYGROUND' | 'D3'
sqlQuerystring nullable
titlestring nullable
type'FOLDER' | 'WORKBOOK' | 'REPORT' required
userIdinteger required
versioninteger nullable
workbookIdinteger nullable

Changes

Changed in 3 of the 11 revisions of this API.21

  • 914d24830bb33See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 97e15146014317See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

  • a0c6b1d2ac961See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog