Skip to main content

Get Works Graphs

Get result graphs for multiple works.

note

This is the batch version of Get Work Graph.

info

Available in Contextal Platform 1.0 and later.

Request

  • Path: /api/v1/get_works_graphs
  • Verb: POST or PUT
  • Content-Type: application/json
  • Body: JSON object in the following form:
    { "work_ids": [ "work_id1", "work_id2", ... ] }
    where "work_id1", "work_id2", ... are the work ids for which the results are requested
note

A maximum of 100 results can be requested per query.

Reply

On success:

  • Status: 200 - Ok
  • Content-Type: application/json
  • Body: A JSON object in the form of:
    {
    "work_id1": <result>,
    "work_id2": <result>,
    ...
    }
    where <result> is either:
    • a JSON object (with the same format described in Get Work Graph
    • null in case the requested work_id was not found

On failure:

  • Status: 5xx