WAwaldronlab
Studies

Get all studies

Changed on
get/studies

Request

Query parameters

direction'ASC' | 'DESC'

Direction of the sort

keywordstring

Search keyword that applies to name and cancer type of the studies

pageNumberinteger

Page number of the result list

pageSizeinteger

Page size of the result list

projection'DETAILED' | 'ID' | 'META' | 'SUMMARY'

Level of detail of the response

sortBy'cancerTypeId' | 'citation' | 'description' | 'groups' | 'importDate' | 'name' | 'pmid' | 'publicStudy' | 'status' | 'studyId'

Name of the property that the result list is sorted by

Response

OK

allSampleCountinteger
cancerTypeIdstring
citationstring
cnaSampleCountinteger
completeSampleCountinteger
descriptionstring
groupsstring
importDatestring
massSpectrometrySampleCountinteger
methylationHm27SampleCountinteger
miRnaSampleCountinteger
mrnaMicroarraySampleCountinteger
mrnaRnaSeqSampleCountinteger
mrnaRnaSeqV2SampleCountinteger
namestring
pmidstring
publicStudyboolean
readPermissionboolean
referenceGenomestring
rppaSampleCountinteger
sequencedSampleCountinteger
statusinteger
studyIdstring required
treatmentCountinteger

Example response

[
  {
    "importDate": "yyyy-MM-dd HH:mm:ss"
  }
]

Changes

  • 74fa8dd31c0dRevision changes
    • warning

      deleted the query request parameter authenticated

    • warning

      deleted the query request parameter authorities[0].authority

    • warning

      deleted the query request parameter credentials

    • warning

      deleted the query request parameter details

    • warning

      deleted the query request parameter principal

  • e741f34f8126Revision changes
    • info

      added the new optional query request parameter authenticated

    • info

      added the new optional query request parameter authorities[0].authority

    • info

      added the new optional query request parameter credentials

    • info

      added the new optional query request parameter details

    • info

      added the new optional query request parameter principal