Skip to content

Projects Endpoint

Endpoint Overview

Project Operations:

  • GET: /admin/projects : return all projects

  • POST: /admin/projects : create a new project

  • GET: /admin/projects/[iri | shortname | shortcode]/<identifier> : returns a single project identified either through iri, shortname, or shortcode

  • PUT: /admin/projects/iri/<identifier> : update a project identified by iri

  • DELETE: /admin/projects/iri/<identifier> : update project status to false

  • GET: /admin/projects/iri/<identifier>/AllData : returns a TriG file containing the project's data

Project Member Operations:

  • GET: /admin/projects/[iri | shortname | shortcode]/<identifier>/members : returns all members part of a project identified through iri, shortname or shortcode

Project Admin Member Operations:

  • GET: /admin/projects/[iri | shortname | shortcode]/<identifier>/admin-members : returns all admin members part of a project identified through iri, shortname or shortcode

Project Keyword Operations:

  • GET: /admin/projects/Keywords : returns all unique keywords for all projects as a list

  • GET: /admin/projects/iri/<identifier>/Keywords : returns all keywords for a single project

Project Restricted View Settings Operations:

  • GET: /admin/projects/iri/<identifier>/RestrictedViewSettings : returns the project's restricted view settings

Project Operations

Create a new project:

  • Required permission: SystemAdmin
  • Required information:
    • shortcode (unique, 4-digits)
    • shortname (unique; it should be in the form of a xsd:NCNAME and it should be URL safe.)
    • description (collection of descriptions as strings with language tag.)
    • keywords (collection of keywords)
    • status (true, if project is active. false, if project is inactive)
    • selfjoin
  • Optional information: longname, logo
  • Returns information about the newly created project
  • Remark: There are two distinct use cases / payload combination:

    (1) change ontology and data graph: ontologygraph, datagraph,

    (2) basic project information: shortcode, shortname, longname, description, keywords, logo, institution, status, selfjoin

  • POST: /admin/projects/

  • BODY:
    {
      "shortname": "newproject",
      "longname": "project longname",
      "description": [{"value": "project description", "language": "en"}],
      "keywords": ["test project"],
      "logo": "/fu/bar/baz.jpg",
      "status": true,
      "selfjoin": false
    }

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

    {
        "id": "http://rdfh.ch/projects/9TaSVMUuiRhQsuWHDPr8rw",
        "shortname": "newprojectWithIri",
        "shortcode": "3333",
        "longname": "new project with a custom IRI",
        "description": [{"value": "a project created with a custom IRI", "language": "en"}],
        "keywords": ["projectWithIRI"],
        "logo": "/fu/bar/baz.jpg",
        "status": true,
        "selfjoin": false
    }   

Default set of permissions for a new project:

When a new project is created, following default permissions are added to its admins and members: - ProjectAdmin group receives an administrative permission to do all project level operations and to create resources within the new project. This administrative permission is retrievable through its IRI: http://rdfh.ch/permissions/[projectShortcode]/defaultApForAdmin

ProjectAdmin group also gets a default object access permission to change rights, delete, modify, view, and restricted view of any entity that belongs to the project. This default object access permission is retrievable through its IRI: http://rdfh.ch/permissions/[projectShortcode]/defaultDoapForAdmin

  • ProjectMember group receives an administrative permission to create resources within the new project. This administrative permission is retrievable through its IRI: http://rdfh.ch/permissions/[projectShortcode]/defaultApForMember

ProjectMember group also gets a default object access permission to modify, view, and restricted view of any entity that belongs to the project. This default object access permission is retrievable through its IRI: http://rdfh.ch/permissions/[projectShortcode]/defaultDoapForMember

Update project information:

  • Required permission: SystemAdmin / ProjectAdmin
  • Changeable information: shortname, longname, description, keywords, logo, status, selfjoin. The payload must at least contain a new value for one of these properties.
  • TypeScript Docs: projectFormats - ChangeProjectApiRequestV1
  • PUT: /admin/projects/iri/<projectIri>
  • BODY:
    {
      "shortname": "newproject",
      "longname": "project longname",
      "description": [{"value": "a new description", "language": "en"}],
      "keywords": ["a new key"],
      "logo": "/fu/bar/baz.jpg",
      "status": true,
      "selfjoin": false
    }

Delete project (update project status):

  • Required permission: SystemAdmin / ProjectAdmin
  • Remark: The same as updating a project and changing status to false. To un-delete, set status to true.
  • DELETE: /admin/projects/iri/<projectIri>
  • BODY: empty

Dump project data:

Returns a TriG file containing the project's ontologies, resource data, admin data, and permissions.

  • Required permission: SystemAdmin / ProjectAdmin
  • Required information: project IRI
  • GET: /admin/projects/iri/<identifier>/AllData

Project Member Operations

Get project members:

  • Required permission: SystemAdmin / ProjectAdmin
  • Required information: project identifier
  • GET: /admin/projects/[iri | shortname | shortcode]/<identifier>/members

Project Admin Member Operations

Get project members:

  • Required permission: SystemAdmin / ProjectAdmin
  • Required information: project identifier
  • GET: /admin/projects/[iri | shortname | shortcode]/<identifier>/admin-members

Restricted View Settings Operations

Operates on the following properties: - knora-admin:projectRestrictedViewSize - takes the IIIF size value - knora-admin:projectRestrictedViewWatermark - takes the path to the watermark image. Currently not used.

Get the restricted view settings:

  • Required permission: ProjectAdmin
  • Required information: identifier. The identifier can be the project's IRI, shortname or shortcode.
  • GET: /admin/projects/[iri | shortname | shortcode]/<identifier>/RestrictedViewSettings

Example Data

The following is an example for project information stored in the admin named graph:

<http://rdfh.ch/projects/00FF>
    rdf:type knora-admin:knoraProject ;
    knora-admin:projectShortname "images"^^xsd:string ;
    knora-admin:projectShortcode "00FF"^^xsd:string ;
    knora-admin:projectLongname "Image Collection Demo"^^xsd:string ;
    knora-admin:projectDescription "A demo project of a collection of images"@en ;
    knora-admin:projectKeyword "images"^^xsd:string,
                              "collection"^^xsd:string ;
    knora-admin:projectRestrictedViewSize "!512,512"^^xsd:string ;
    knora-admin:projectRestrictedViewWatermark "path_to_image"^^xsd:string ;
    knora-admin:belongsToInstitution <http://rdfh.ch/institutions/dhlab-basel> ;
    knora-admin:status "true"^^xsd:boolean ;
    knora-admin:hasSelfJoinEnabled "false"^^xsd:boolean .

Last update: 2021-09-08