UCLouvain

UCLouvain Mydata API

The Mydata API from UCLouvain — 2 operation(s) for mydata.

GitHub OpenAPI

Documentation

📖
Documentation
https://guides.dataverse.org/en/latest/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/openapi/uclouvain-mydata-api-openapi.yml

Other Resources

🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/json-schema/uclouvain-dataset-schema.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/json-structure/uclouvain-dataset-structure.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/examples/uclouvain-search-example.json
🔗
x-rules
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/rules/uclouvain-rules.yml
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/vocabulary/uclouvain-vocabulary.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/json-ld/uclouvain-context.jsonld

OpenAPI Specification

uclouvain-mydata-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Dataverse Access Mydata API
  description: Open source research data repository software.
  version: '6.8'
servers:
- url: https://dataverse.uclouvain.be/api
  description: Open Data @ UCLouvain Dataverse instance (v6.8)
tags:
- name: Mydata
paths:
  /mydata/retrieve:
    get:
      operationId: DataRetrieverAPI_retrieveMyDataAsJsonString
      parameters:
      - name: dataset_valid
        in: query
        schema:
          type: array
          items:
            type: boolean
      - name: dvobject_types
        in: query
        schema:
          type: array
          items:
            $ref: '#/components/schemas/DType'
      - name: filter_validities
        in: query
        schema:
          type: boolean
      - name: mydata_search_term
        in: query
        schema:
          type: string
      - name: published_states
        in: query
        schema:
          type: array
          items:
            type: string
      - name: role_ids
        in: query
        schema:
          type: array
          items:
            format: int64
            type: integer
      - name: selected_page
        in: query
        schema:
          format: int32
          type: integer
      - name: userIdentifier
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
      tags:
      - Mydata
  /mydata/retrieve/collectionList:
    get:
      operationId: DataRetrieverAPI_retrieveMyCollectionList
      parameters:
      - name: userIdentifier
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Mydata
components:
  schemas:
    DType:
      enum:
      - Dataverse
      - Dataset
      - DataFile
      type: string