University of Groningen

University of Groningen role API

The role API from University of Groningen — 2 operation(s) for role.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.rug.nl/library/support/pure/?lang=en
📖
Authentication
https://www.rug.nl/library/support/pure/?lang=en
📖
Documentation
https://guides.dataverse.org/en/latest/api/native-api.html
📖
Documentation
https://www.rug.nl/digital-competence-centre/research-data/archive-and-publish/open-data?lang=en

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/university-of-groningen/refs/heads/main/openapi/university-of-groningen-role-api-openapi.yml

Other Resources

🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/university-of-groningen/refs/heads/main/vocabulary/university-of-groningen-vocabulary.yml
🔗
x-rules
https://raw.githubusercontent.com/api-evangelist/university-of-groningen/refs/heads/main/rules/university-of-groningen-rules.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/university-of-groningen/refs/heads/main/json-ld/university-of-groningen-context.jsonld

OpenAPI Specification

university-of-groningen-role-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Dataverse Access role API
  description: Open source research data repository software.
  version: '6.9'
servers:
- url: https://dataverse.nl
tags:
- name: role
paths:
  /roles:
    get:
      tags:
      - role
      summary: Lists all assignable roles
      description: Lists all assignable roles that are currently available
      operationId: role_get_assignable_roles
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AssignableRole'
  /roles/{assignableRoleName}:
    get:
      tags:
      - role
      summary: Returns an assignable role
      description: Returns an assignable role if it is currently available
      operationId: role_get_assignable_role
      parameters:
      - name: assignableRoleName
        in: path
        description: Get assignable role from assignable role name.
        required: true
        schema:
          pattern: .+
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssignableRole'
components:
  schemas:
    LocalizedString:
      type: object
      additionalProperties:
        type: string
        description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.'
        nullable: true
        example: '{"en_GB":"Some text"}'
      description: 'A set of string values, one for each submission locale. Note: invalid locale values will be ignored.'
      nullable: true
      example:
        en_GB: Some text
    AssignableRole:
      required:
      - assignableRoleName
      type: object
      properties:
        assignableRoleName:
          type: string
          description: The name of the assignable role
        targetSystemName:
          type: string
          description: The name of the target system
          nullable: true
        title:
          $ref: '#/components/schemas/LocalizedString'
      description: An assignable role