Skip to content

Latest commit

 

History

History
141 lines (107 loc) · 4.4 KB

lists.md

File metadata and controls

141 lines (107 loc) · 4.4 KB
Raw

Lists Endpoint

Endpoint Overview

List Operations:

  • GET: /admin/lists[?projectIri=<projectIri>] : return all lists optionally filtered by project
  • GET: /admin/lists/<listIri> : return complete list with children
  • POST: /admin/lists : create new list
  • PUT: /admin/lists/<listIri> : update list information
  • POST: /admin/lists/<nodeIri> : create new child node under the supplied parent node IRI
  • NOT IMPLEMENTED: DELETE: /admin/lists/<listIri> : delete list including children if not used
  • GET: /admin/lists/infos/<listIri> : return list information (without children)

List Node operations

  • GET: /admin/lists/nodes/<nodeIri> : return list node information (without children)
  • NOT IMPLEMENTED: POST: /admin/lists/nodes/<nodeIri> : update list node information
  • NOT IMPLEMENTED: DELETE: /admin/lists/nodes/<nodeIri> : delete list node including children if not used

List Operations

Get lists

  • Required permission: none
  • Return all lists optionally filtered by project
  • GET: /admin/lists[?projectIri=<projectIri>]

Get list

  • Required permission: none
  • Return complete list with children
  • GET: /admin/lists/<listIri>

Create new list

  • Required permission: SystemAdmin / ProjectAdmin
  • POST: /admin/lists
  • BODY:
    {
        "projectIri": "someprojectiri",
        "labels": [{ "value": "Neue Liste", "language": "de"}],
        "comments": []
    }

Additionally, each list can have an optional custom IRI (of Knora IRI form) specified by the id in the request body as below:

    {
        "id": "http://rdfh.ch/lists/0001/a-list-with-IRI",
        "projectIri": "http://rdfh.ch/projects/0001",
        "labels": [{ "value": "Neue Liste mit IRI", "language": "de"}],
        "comments": []
    }

Create new child node

  • Required permission: SystemAdmin / ProjectAdmin
  • Appends a new child node under the supplied nodeIri. If the supplied nodeIri is the listIri, then a new child node is appended to the top level. Children are currently only appended.
  • POST: /admin/lists/<nodeIri>
  • BODY:
    {
        "parentNodeIri": "nodeIri",
        "projectIri": "someprojectiri",
        "name": "first",
        "labels": [{ "value": "New First Child List Node Value", "language": "en"}],
        "comments": [{ "value": "New First Child List Node Comment", "language": "en"}]
    }

Get list's information

  • Required permission: none
  • Return list information (without children)
  • GET: /admin/lists/infos/<listIri>

Update list's information

The basic information of a list such as its labels, comments, name, or all of them can be updated. The parameters that must be updated together with the new value must be given in the JSON body of the request together with the IRI of the list and the IRI of the project it belongs to.

  • Required permission: none
  • Update list information
  • PUT: /admin/lists/<listIri>
  • BODY:
   {
       "listIri": "listIri",
       "projectIri": "someprojectiri",
       "name": "a new name",
       "labels": [{ "value": "Neue geönderte Liste", "language": "de"}, { "value": "Changed list", "language": "en"}],
       "comments": [{ "value": "Neuer Kommentar", "language": "de"}, { "value": "New comment", "language": "en"}]
   }

If only name of the list must be updated, it can be given as below in the body of the request:

   {
       "listIri": "listIri",
       "projectIri": "someprojectiri",
       "name": "another name"
  }

List Node Operations

Get List Node Information

  • Required permission: none
  • Return list node information (without children)
  • GET: /admin/lists/nodes/<nodeIri>