ProReport - Update report instance

API Url

Used for updating a report instance: either temporary state (save to repository) or other attributes.

PUT

http://localhost:16010/ProMarkREST/rest/ProReport/repository/{id}

Permissions: user

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
savedReports	Object[]	Object with report instances.
desc	String	Description of the report instance.
expiry	Date	Date when report will stop being available in the repository.
fileId	String	Unique identifier of the report files (not updatable). Needed when opening reports.
id	String	Unique identifier of the report instance (not updatable).
parentId	String	Unique identifier of the report used when running this instance (not updatable).
recurrent	Boolean	true=Report is part of a recurrence series (not updatable).
reportType	String	Report type (0=Classic report, 1=Excel report, 2=Host report).
runTime	Datetime	Date and time when report was executed (not updatable). If 'null', the report was not yet executed (delayed execution).
private	Boolean	true=Report is visible only by Owner, Administrator and shared list of users.
sharedWith`optional`	String	A list of users ids of users that have access to the report.

Path parameters

Field	Type	Description
id	String	Unique identifier of the report instance.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
errorCode	Number	Error code.
errorMessage	String	Error description.

Error example:

HTTP/1.1 404 Not found
   {
      "response": {
         "errorCode": 285,
         "errorMessage": "The report was not found. Maybe it was deleted by another user."
      }
   }