Vidispine logs¶
Retrieving log files¶
New in version 3.3.
If your application has a custom form for reporting issues then you can
collect the log files using the vidispine-logs
resource.
Get log files¶
-
GET
/vidispine-logs
¶ Query Parameters: - starttime – Mandatory ISO 8601 start time of time span.
- endtime – Mandatory ISO 8601 end time of time span.
- comment – Optional detailed description of what the problem is, to be written in zip file.
- user – Optional comma-separated list of user names to retrieve information about.
- storage – Optional comma-separated list of storage ids to retrieve information about.
- item – Optional comma-separated list of item ids to retrieve information about.
- job – Optional comma-separated list of job ids to retrieve information about.
- selftest – If true, includes the result of a self-test. Default false.
Produces: - application/zip – A zip file with various log files collated.
- multipart/form-data , multipart/mixed –
A multi-part response, with parts:
zip
Containing the zip file.message-text
Containing CRLF-separated list of warnings.message-json
Containing JSON array list of warnings.
Log retrieval jobs¶
New in version 4.5.
Instead of a synchronous call, Vidispine can also start a pseudo-job that creates the log report in the background. This is not a real Vidispine job, so there are no priorities, notifications, etc.
In case of a restart of Vidispine, the job is aborted. Finished jobs are stored in a temporary location, however.
Start log report job¶
-
POST
/vidispine-logs/job
¶ Query Parameters: - starttime – Mandatory ISO 8601 start time of time span.
- endtime – Mandatory ISO 8601 end time of time span.
- comment – Optional detailed description of what the problem is, to be written in zip file.
- user – Optional comma-separated list of user names to retrieve information about.
- storage – Optional comma-separated list of storage ids to retrieve information about.
- item – Optional comma-separated list of item ids to retrieve information about.
- job – Optional comma-separated list of job ids to retrieve information about.
- selftest – If true, includes the result of a self-test. Default false.
Produces: - application/xml, application/json – A JobDocument that describes the job.
Return all jobs¶
-
GET
/vidispine-logs/job
¶ Return information about all jobs that have not expired.
Produces: - application/xml, application/json – JobListDocument
Get job status¶
-
GET
/vidispine-logs/job/
(job-id)¶ Return information about specified job.
Produces: - application/xml, application/json – JobDocument
Upload of logs to Vidispine¶
New in version 4.5.
If a log has been created by a job, Vidispine can upload it to vidispine.com. In addition, source files referenced by items entered in the log report can be attached. This is a two-phase operation, first query the API of what files there are, then start the job.
Status of upload is included in the log report job, see above.
Get job files¶
-
GET
/vidispine-logs/job/
(job-id)/uri
¶ Return file information about specified job.
Produces: - application/json – An array of objects with keys name, displayUri, uri, and size
Start upload¶
-
POST
/vidispine-logs/job/
(job-id)/upload
¶ Starts upload.
Accepts: - application/xml, application/json – A URIListDocument with URIs from the list of files in the log.