Chalmers University of Technology

Chalmers University of Technology ProjectSearch API

The ProjectSearch API from Chalmers University of Technology — 1 operation(s) for projectsearch.

GitHub OpenAPI

Documentation

📖
Documentation
https://api.research.chalmers.se/Help

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/openapi/chalmers-university-of-technology-projectsearch-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/json-schema/chalmers-university-of-technology-project-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/json-schema/chalmers-university-of-technology-organization-schema.json

Other Resources

🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/json-structure/chalmers-university-of-technology-project-structure.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/json-structure/chalmers-university-of-technology-organization-structure.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/examples/chalmers-university-of-technology-get-project-example.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/examples/chalmers-university-of-technology-get-organization-example.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/examples/chalmers-university-of-technology-projectsearch-example.json
🔗
x-spectral-rules
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/rules/chalmers-university-of-technology-rules.yml
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/vocabulary/chalmers-university-of-technology-vocabulary.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/chalmers-university-of-technology/refs/heads/main/json-ld/chalmers-university-of-technology-context.jsonld

OpenAPI Specification

chalmers-university-of-technology-projectsearch-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: ChalmersResearch ContractImport ProjectSearch API
  version: v1
  description: Public API serving research information from the Chalmers Research portal, including research projects, publications, funders/organizations and collaborations. Converted from the live Swagger 2.0 description at https://api.research.chalmers.se/swagger/docs/v1.
servers:
- url: https://api.research.chalmers.se
tags:
- name: ProjectSearch
paths:
  /api/ProjectSearch:
    get:
      tags:
      - ProjectSearch
      summary: General search for projects.
      operationId: ProjectSearch_GetByQuery
      deprecated: false
      parameters:
      - name: query
        in: query
        required: false
        description: Lucene style query.
        schema:
          type: string
      - name: funder
        in: query
        required: false
        description: Funder (Organization) Id.
        schema:
          type: string
      - name: funderId
        in: query
        required: false
        description: FunderId.
        schema:
          type: string
      - name: max
        in: query
        required: false
        description: Max number of documents to return.
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        required: false
        description: Starting position.
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        required: false
        description: Sort field.
        schema:
          type: string
      - name: sortOrder
        in: query
        required: false
        description: Sort order.
        schema:
          type: string
      - name: selectedFields
        in: query
        required: false
        description: Comma-separated list of fields to return.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectQueryResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ProjectQueryResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProjectQueryResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/ProjectQueryResult'
components:
  schemas:
    PersonOrganizationParent:
      type: object
      properties:
        Id:
          type: string
        FromDate:
          format: date-time
          type: string
        ToDate:
          format: date-time
          type: string
        ParentOrganizationId:
          type: string
        ParentOrganizationData:
          $ref: '#/components/schemas/PersonOrganization'
    PersonOrganization:
      type: object
      properties:
        Id:
          type: string
        NameSwe:
          type: string
        NameEng:
          type: string
        DisplayNameSwe:
          type: string
        DisplayNameEng:
          type: string
        DisplayPathSwe:
          type: string
        DisplayPathEng:
          type: string
        DisplayPathShortSwe:
          type: string
        DisplayPathShortEng:
          type: string
        PossibleDisplayPaths:
          type: array
          items:
            $ref: '#/components/schemas/PersonDisplayPath'
        City:
          type: string
        PostalNo:
          type: string
        Country:
          type: string
        GeoLat:
          type: string
        GeoLong:
          type: string
        Level:
          format: int32
          type: integer
        StartYear:
          format: int32
          type: integer
        EndYear:
          format: int32
          type: integer
        OrganizationTypes:
          type: array
          items:
            $ref: '#/components/schemas/PersonOrganizationType'
        OrganizationParents:
          type: array
          items:
            $ref: '#/components/schemas/PersonOrganizationParent'
        ActiveOrganizationParentIds:
          type: array
          items:
            type: string
        HasIdentifiers:
          type: boolean
        IdentifiersCount:
          format: int32
          type: integer
        Identifiers:
          type: array
          items:
            $ref: '#/components/schemas/PersonOrganizationIdentifier'
        IdentifierLdapCode:
          type: array
          items:
            type: string
        IdentifierCplDepartmentId:
          type: array
          items:
            type: string
        CreatedBy:
          type: string
        CreatedAt:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        UpdatedAt:
          format: date-time
          type: string
        ValidatedBy:
          type: string
        ValidatedDate:
          format: date-time
          type: string
        DeletedBy:
          type: string
        DeletedAt:
          format: date-time
          type: string
        NeedsAttention:
          type: boolean
        IsReplacedById:
          type: string
        IsActive:
          type: boolean
    ProjectCategory:
      type: object
      properties:
        ID:
          format: int32
          type: integer
        ProjectID:
          format: int32
          type: integer
        CategoryID:
          type: string
        Category:
          $ref: '#/components/schemas/Category'
    PersonOrganizationType:
      type: object
      properties:
        Id:
          type: string
        NameSwe:
          type: string
        NameEng:
          type: string
        LegacyOrganizationTypeId:
          format: int32
          type: integer
    OrganizationOrganizationType:
      type: object
      properties:
        Id:
          type: string
        NameSwe:
          type: string
        NameEng:
          type: string
        LegacyOrganizationTypeId:
          format: int32
          type: integer
    OrganizationDisplayPath:
      type: object
      properties:
        DisplayPathSwe:
          type: string
        DisplayPathEng:
          type: string
    ProjectContractIdentifier:
      type: object
      properties:
        ID:
          format: int32
          type: integer
        ProjectContractID:
          format: int32
          type: integer
        ProjectContractIdentifierID:
          format: int32
          type: integer
        ProjectContractIdentifierDescription:
          type: string
        ProjectContractIdentifierValue:
          type: string
    ProjectOrganizationPersonOrganization:
      type: object
      properties:
        ID:
          format: int32
          type: integer
        OrganizationID:
          type: string
        StartDate:
          format: date-time
          type: string
        EndDate:
          format: date-time
          type: string
        ProjectOrganizationPersonID:
          format: int32
          type: integer
        OrganizationData:
          $ref: '#/components/schemas/OrganizationOrganization'
    PdbCategory:
      type: object
      properties:
        Id:
          type: string
        Name:
          type: string
        StartDate:
          format: date-time
          type: string
        EndDate:
          format: date-time
          type: string
    OrganizationOrganizationParent:
      type: object
      properties:
        Id:
          type: string
        FromDate:
          format: date-time
          type: string
        ToDate:
          format: date-time
          type: string
        ParentOrganizationId:
          type: string
        ParentOrganizationData:
          $ref: '#/components/schemas/OrganizationOrganization'
    PersonIdentifierType:
      type: object
      properties:
        Id:
          type: string
        Value:
          type: string
        DescriptionSwe:
          type: string
        DescriptionEng:
          type: string
    Category:
      type: object
      properties:
        Id:
          type: string
        NameSwe:
          type: string
        NameEng:
          type: string
        Type:
          $ref: '#/components/schemas/CategoryType'
        Identifiers:
          type: array
          items:
            $ref: '#/components/schemas/Identifier'
    ProjectQueryResult:
      type: object
      properties:
        TotalCount:
          format: int32
          type: integer
        Projects:
          type: array
          items:
            $ref: '#/components/schemas/Project'
    PersonOrganizationIdentifierType:
      type: object
      properties:
        Id:
          type: string
        Value:
          type: string
        DescriptionSwe:
          type: string
        DescriptionEng:
          type: string
    PersonOrganizationIdentifier:
      type: object
      properties:
        Id:
          type: string
        Type:
          $ref: '#/components/schemas/PersonOrganizationIdentifierType'
        CreatedBy:
          type: string
        CreatedAt:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        UpdatedAt:
          format: date-time
          type: string
        IsActive:
          type: boolean
        Value:
          type: string
    Project:
      type: object
      properties:
        ID:
          format: int32
          type: integer
        ProjectTitleSwe:
          type: string
        ProjectDescriptionSwe:
          type: string
        ProjectDescriptionSweHtml:
          type: string
        ProjectTitleEng:
          type: string
        ProjectDescriptionEng:
          type: string
        ProjectDescriptionEngHtml:
          type: string
        PublishStatus:
          format: int32
          type: integer
        StartDate:
          format: date-time
          type: string
        EndDate:
          format: date-time
          type: string
        ProjectSource:
          description: The information source that the project was created from
          type: string
        CreatedDate:
          format: date-time
          type: string
        CreatedBy:
          type: string
        UpdatedDate:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        Contracts:
          type: array
          items:
            $ref: '#/components/schemas/ProjectContract'
        Identifiers:
          type: array
          items:
            $ref: '#/components/schemas/ProjectIdentifier'
        Organizations:
          type: array
          items:
            $ref: '#/components/schemas/ProjectOrganization'
        Persons:
          type: array
          items:
            $ref: '#/components/schemas/ProjectOrganizationPerson'
        Categories:
          type: array
          items:
            $ref: '#/components/schemas/ProjectCategory'
        Keywords:
          type: array
          items:
            $ref: '#/components/schemas/ProjectKeyword'
    ProjectIdentifier:
      type: object
      properties:
        ID:
          format: int32
          type: integer
        ProjectID:
          format: int32
          type: integer
        ProjectIdentifierID:
          format: int32
          type: integer
        ProjectIdentifierDescription:
          type: string
        ProjectIdentifierValue:
          type: string
    PersonPerson:
      type: object
      properties:
        Id:
          type: string
        FirstName:
          type: string
        LastName:
          type: string
        DisplayName:
          type: string
        BirthYear:
          format: int32
          type: integer
        IsReplacedById:
          type: string
        IsReplacingId:
          type: string
        IsActive:
          type: boolean
        IsDeleted:
          type: boolean
        HasOrganizationHome:
          type: boolean
        HasIdentifiers:
          type: boolean
        HasPublications:
          type: boolean
        HasProjects:
          type: boolean
        OrganizationHomeCount:
          format: int32
          type: integer
        IdentifiersCount:
          format: int32
          type: integer
        IdentifierCid:
          type: array
          items:
            type: string
        IdentifierCplPersonId:
          type: array
          items:
            type: string
        IdentifierOrcid:
          type: array
          items:
            type: string
        Identifiers:
          type: array
          items:
            $ref: '#/components/schemas/PersonIdentifier'
        OrganizationHome:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationHome'
        PdbCategories:
          type: array
          items:
            $ref: '#/components/schemas/PdbCategory'
        CreatedBy:
          type: string
        CreatedAt:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        UpdatedAt:
          format: date-time
          type: string
        DeletedBy:
          type: string
        DeletedAt:
          format: date-time
          type: string
        SightedBy:
          type: string
        SightedAt:
          format: date-time
          type: string
        ValidatedBy:
          type: string
        ValidatedDate:
          format: date-time
          type: string
        NeedsAttention:
          type: boolean
    OrganizationIdentifier:
      type: object
      properties:
        Id:
          type: string
        Type:
          $ref: '#/components/schemas/OrganizationIdentifierType'
        CreatedBy:
          type: string
        CreatedAt:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        UpdatedAt:
          format: date-time
          type: string
        IsActive:
          type: boolean
        Value:
          type: string
    ProjectOrganizationPerson:
      description: Connects a person with affiliation to a project
      type: object
      properties:
        ID:
          format: int32
          type: integer
        ProjectID:
          format: int32
          type: integer
        PersonID:
          type: string
        OrganizationID:
          type: string
        PersonRoleID:
          format: int32
          type: integer
        PersonRoleName_en:
          type: string
        PersonRoleName_sc:
          type: string
        Person:
          $ref: '#/components/schemas/PersonPerson'
        PersonOrganizations:
          type: array
          items:
            $ref: '#/components/schemas/ProjectOrganizationPersonOrganization'
        Verified:
          format: date-time
          description: The date for a users verification as a project member
          type: string
        VerificationMailSent:
          format: date-time
          description: The date for sending a users verification email
          type: string
    OrganizationHome:
      type: object
      properties:
        Id:
          type: string
        OrganizationId:
          type: string
        OrganizationData:
          $ref: '#/components/schemas/PersonOrganization'
        LastUpdatedDate:
          format: date-time
          type: string
        TitleSwe:
          type: string
        TitleEng:
          type: string
        StartDate:
          format: date-time
          type: string
        EndDate:
          format: date-time
          type: string
        Source:
          type: string
        Priority:
          type: string
    ProjectOrganization:
      type: object
      properties:
        ID:
          format: int32
          type: integer
        ProjectID:
          format: int32
          type: integer
        OrganizationID:
          type: string
        Organization:
          $ref: '#/components/schemas/OrganizationOrganization'
        OrganizationRoleID:
          format: int32
          type: integer
        OrganizationRoleNameEn:
          type: string
        OrganizationRoleNameSv:
          type: string
    CategoryType:
      type: object
      properties:
        Id:
          type: string
        NameSwe:
          type: string
        NameEng:
          type: string
    Identifier:
      type: object
      properties:
        Id:
          type: string
        Type:
          $ref: '#/components/schemas/IdentifierType'
        CreatedBy:
          type: string
        CreatedAt:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        UpdatedAt:
          format: date-time
          type: string
        IsActive:
          type: boolean
        Value:
          type: string
    ProjectContract:
      type: object
      properties:
        ID:
          format: int32
          description: Primary key for FundingContracts
          type: integer
        EkoImportID:
          format: int32
          description: Id number used in EKO-database for this contract
          type: integer
        ContractSource:
          description: The information source that the project was created from
          type: string
        DmpValue:
          description: Data Management Plan (DMP), link or id
          type: string
        DmpVersion:
          description: Data Management Plan (DMP), version
          type: string
        ProjectID:
          format: int32
          description: Internal id of project
          type: integer
        OrganizationID:
          description: Internal id of funding organization
          type: string
        ContractStartDate:
          format: date-time
          description: Start date for funding
          type: string
        ContractEndDate:
          format: date-time
          description: End date for funding
          type: string
        ContractAmount:
          format: int32
          description: Funding amount
          type: integer
        ContractCurrencyCode:
          description: Funding currency code
          type: string
        FunderID:
          description: Funder ID(s), virtual field
          type: array
          items:
            type: string
        CreatedDate:
          format: date-time
          type: string
        CreatedBy:
          type: string
        UpdatedDate:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        ContractOrganization:
          $ref: '#/components/schemas/OrganizationOrganization'
        ContractIdentifiers:
          type: array
          items:
            $ref: '#/components/schemas/ProjectContractIdentifier'
    PersonDisplayPath:
      type: object
      properties:
        DisplayPathSwe:
          type: string
        DisplayPathEng:
          type: string
    PersonIdentifier:
      type: object
      properties:
        Id:
          type: string
        Type:
          $ref: '#/components/schemas/PersonIdentifierType'
        CreatedBy:
          type: string
        CreatedAt:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        UpdatedAt:
          format: date-time
          type: string
        IsActive:
          type: boolean
        Value:
          type: string
    ProjectKeyword:
      type: object
      properties:
        ID:
          format: int32
          type: integer
        ProjectID:
          format: int32
          type: integer
        Value:
          type: string
        Lang:
          type: string
        Type:
          format: int32
          type: integer
    OrganizationOrganization:
      type: object
      properties:
        Id:
          type: string
        NameSwe:
          type: string
        NameEng:
          type: string
        DisplayNameSwe:
          type: string
        DisplayNameEng:
          type: string
        DisplayPathSwe:
          type: string
        DisplayPathEng:
          type: string
        DisplayPathShortSwe:
          type: string
        DisplayPathShortEng:
          type: string
        PossibleDisplayPaths:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationDisplayPath'
        City:
          type: string
        PostalNo:
          type: string
        Country:
          type: string
        GeoLat:
          type: string
        GeoLong:
          type: string
        Level:
          format: int32
          type: integer
        StartYear:
          format: int32
          type: integer
        EndYear:
          format: int32
          type: integer
        OrganizationTypes:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationOrganizationType'
        OrganizationParents:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationOrganizationParent'
        ActiveOrganizationParentIds:
          type: array
          items:
            type: string
        HasIdentifiers:
          type: boolean
        IdentifiersCount:
          format: int32
          type: integer
        Identifiers:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationIdentifier'
        IdentifierLdapCode:
          type: array
          items:
            type: string
        IdentifierCplDepartmentId:
          type: array
          items:
            type: string
        CreatedBy:
          type: string
        CreatedAt:
          format: date-time
          type: string
        UpdatedBy:
          type: string
        UpdatedAt:
          format: date-time
          type: string
        ValidatedBy:
          type: string
        ValidatedDate:
          format: date-time
          type: string
        DeletedBy:
          type: string
        DeletedAt:
          format: date-time
          type: string
        NeedsAttention:
          type: boolean
        IsReplacedById:
          type: string
        IsActive:
          type: boolean
    OrganizationIdentifierType:
      type: object
      properties:
        Id:
          type: string
        Value:
          type: string
        DescriptionSwe:
          type: string
        DescriptionEng:
          type: string
    IdentifierType:
      type: object
      properties:
        Id:
          type: string
        Value:
          type: string
        DescriptionSwe:
          type: string
        DescriptionEng:
          type: string
  securitySchemes:
    basic:
      type: http
      scheme: basic
      description: Basic HTTP Authentication