Utrecht University datarequest API

openapi: 3.2.0
x-method: searched
x-source-url: https://github.com/UtrechtUniversity/yoda-ruleset/blob/development/tools/api/generate-openapi.py
x-provenance: >-
  Utrecht University's own document. The Yoda OpenAPI is emitted by
  tools/api/generate-openapi.py in github.com/UtrechtUniversity/yoda-ruleset
  ('Copyright (c) 2020-2026, Utrecht University', GPLv3), which walks the ruleset's own
  function signatures and docstrings; --core yields 'Yoda core API' and --module <m> yields
  'Yoda <m> API'. Fetched and then split per tag by refine-openapis; the pristine sources are
  in openapi/_original/. Re-based off the upstream placeholder host portal.yoda.test onto the
  verified production host portal.yoda.uu.nl on 2026-08-30, and the refine title weld
  ('Yoda core admin <X> API' on 19 non-admin outputs) repaired at the same time.
x-generated: '2026-08-30'
info:
  description: >-
    Yoda datarequest ruleset — the data-request workflow of Yoda, the iRODS-based research data management platform developed and operated by Utrecht University.
  contact:
    email: l.r.westerhof@uu.nl
  version: 2.1.0
  title: Yoda Datarequest API
servers:
- url: https://portal.yoda.uu.nl/api
  description: Utrecht University production Yoda portal (verified live 2026-08-30; API requires an
    authenticated session or a Yoda data access token)
- url: https://i-lab.yoda.uu.nl/api
  description: Utrecht University i-Lab Yoda portal (verified live 2026-08-30)
x-operator: institution
x-placeholder-removed: >-
  The upstream Yoda repository ships servers[] as https://portal.yoda.test/api,
  'Local Yoda development server'. .test is an RFC 2606 reserved TLD and is never a
  surface, so it is dropped from servers[] rather than carried as an unattributable
  host. It is recorded here so a later run does not read its absence as data loss.
x-operator-evidence: >-
  Yoda is authored by Utrecht University (github.com/UtrechtUniversity/yoda-ruleset, GPL-3.0,
  "Copyright (c) Utrecht University") and Utrecht runs its own production instance at
  portal.yoda.uu.nl. info.contact is l.r.westerhof@uu.nl, a uu.nl address. This is the
  institution's own engineering, not a vendor contract running under its name.
security:
- cookieAuth: []
- basicAuth: []
tags:
- name: datarequest
paths:
  /datarequest_action_permitted:
    post:
      tags:
      - datarequest
      summary: 'Wrapper around datarequest_action_permitted.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              - roles
              - statuses
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
                roles:
                  type: array
                  description: 'List of permitted roles (possible values: PM, ED, DM, DAC, OWN, REV)'
                  default: null
                  items: {}
                statuses:
                  type: array
                  description: List of permitted current data request statuses or None (check skipped)
                  default: null
                  items: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_roles_get:
    post:
      tags:
      - datarequest
      summary: "Get roles of invoking user.\n                   if this parameter is missing)\n"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                request_id:
                  type:
                  - string
                  - 'null'
                  description: Unique identifier of the data request (OWN and REV roles will not be checked
                  default: None
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_schema_get:
    post:
      tags:
      - datarequest
      summary: ''
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - schema_name
              properties:
                schema_name:
                  type: string
                  description: (undocumented)
                  default: null
                version:
                  type: string
                  description: (undocumented)
                  default: SCHEMA_VERSION
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_resubmission_id_get:
    post:
      tags:
      - datarequest
      summary: 'Given a request ID, get the request ID of the associated resubmitted data request.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_browse:
    post:
      tags:
      - datarequest
      summary: "Get paginated datarequests, including size/modify date information.\n                    show non-archived data requests\n                    be reviewed\n"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sort_on:
                  type: string
                  description: Column to sort on ('name', 'modified')
                  default: '''name'''
                sort_order:
                  type: string
                  description: Column sort order ('asc' or 'desc')
                  default: '''asc'''
                offset:
                  type: integer
                  description: Offset to start browsing from
                  default: '0'
                limit:
                  type: integer
                  description: Limit number of results
                  default: '10'
                archived:
                  type: boolean
                  description: If true, show archived (i.e. rejected) data requests only. If false, only
                  default: 'False'
                dacrequests:
                  type: boolean
                  description: If true, show a DAC member's own data requests (instead of data requests to
                  default: 'True'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_submit:
    post:
      tags:
      - datarequest
      summary: 'Persist a data request to disk.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              - draft
              properties:
                data:
                  type: object
                  description: Contents of the data request
                  default: null
                draft:
                  type: boolean
                  description: Boolean specifying whether the data request should be saved as draft
                  default: null
                draft_request_id:
                  type:
                  - string
                  - 'null'
                  description: Unique identifier of the draft data request
                  default: None
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_get:
    post:
      tags:
      - datarequest
      summary: 'Retrieve a data request.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: integer
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_attachment_upload_permission:
    post:
      tags:
      - datarequest
      summary: '                   revoked ("grantread" or "revoke")

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              - action
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
                action:
                  type: string
                  description: String specifying whether write permission must be granted ("grant") or
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_attachment_post_upload_actions:
    post:
      tags:
      - datarequest
      summary: 'Grant read permissions on the attachment to the owner of the associated data request.

        :param filename:   Filename of attachment'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              - filename
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
                filename:
                  type: string
                  description: Filename of attachment
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_attachments_get:
    post:
      tags:
      - datarequest
      summary: 'Get all attachments of a given data request.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_attachments_submit:
    post:
      tags:
      - datarequest
      summary: 'Finalize the submission of uploaded attachments

        :param request_id: Unique identifier of the data request'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_preliminary_review_submit:
    post:
      tags:
      - datarequest
      summary: 'Persist a preliminary review to disk.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              - request_id
              properties:
                data:
                  type: object
                  description: Contents of the preliminary review
                  default: null
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_preliminary_review_get:
    post:
      tags:
      - datarequest
      summary: 'Retrieve a preliminary review.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_datamanager_review_submit:
    post:
      tags:
      - datarequest
      summary: 'Persist a datamanager review to disk.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              - request_id
              properties:
                data:
                  type: object
                  description: Contents of the datamanager review
                  default: null
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_datamanager_review_get:
    post:
      tags:
      - datarequest
      summary: 'Retrieve a data manager review.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_dac_members_get:
    post:
      tags:
      - datarequest
      summary: ''
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: (undocumented)
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_assignment_submit:
    post:
      tags:
      - datarequest
      summary: 'Persist an assignment to disk.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              - request_id
              properties:
                data:
                  type: object
                  description: Contents of the assignment
                  default: null
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_assignment_get:
    post:
      tags:
      - datarequest
      summary: 'Retrieve assignment.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_review_submit:
    post:
      tags:
      - datarequest
      summary: 'Persist a data request review to disk.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              - request_id
              properties:
                data:
                  type: object
                  description: Contents of the review
                  default: null
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_reviews_get:
    post:
      tags:
      - datarequest
      summary: 'Retrieve a data request review.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_evaluation_submit:
    post:
      tags:
      - datarequest
      summary: 'Persist an evaluation to disk.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              - request_id
              properties:
                data:
                  type: object
                  description: Contents of the evaluation
                  default: null
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_approval_conditions_get:
    post:
      tags:
      - datarequest
      summary: 'Retrieve approval conditions

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_evaluation_get:
    post:
      tags:
      - datarequest
      summary: 'Retrieve an evaluation.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_feedback_get:
    post:
      tags:
      - datarequest
      summary: 'Get feedback for researcher

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_preregistration_submit:
    post:
      tags:
      - datarequest
      summary: 'Persist a preregistration to disk.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              - request_id
              properties:
                data:
                  type: object
                  description: Contents of the preregistration
                  default: null
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_preregistration_get:
    post:
      tags:
      - datarequest
      summary: 'Retrieve a preregistration.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - request_id
              properties:
                request_id:
                  type: string
                  description: Unique identifier of the data request
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /datarequest_preregistration_confirm:
    post:
      tags:
      - datarequest
      summary: 'Set the status of a submitted da

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/utrecht/refs/heads/main/openapi/utrecht-datarequest-api-openapi.yml