categories

Retrieve all categories.

Changed on

Retrieve all categories.

get/categories

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/categories
  • Auth
    none declared

Query parameters

namestring

Name of category to retrieve

includestring

Comma-delimited list of fields to include: entries

limitinteger

Maximum number of results to return

offsetinteger

Offset of the first result to return

Response

Successfully retrieved categories

aliasesobject
dbCreateDateinteger
dbUpdateDateinteger
descriptionstring

Description of the collection

displayNamestring
idinteger

Implementation specific ID for the collection in this web service

metadataobject

Arbitrary metadata for this collection, settable only by admins and curators

namestring required

Name of the collection

notebooksLengthinteger

Number of notebooks inside this collection

organizationIDinteger
organizationNamestring
servicesLengthinteger

Number of services inside this collection

toolsLengthinteger

Number of tools inside this collection

topicstring required

Short description of the collection

workflowsLengthinteger

Number of workflows inside this collection

Example response

[
  {
    "name": "alignment",
    "topic": "A collection of alignment algorithms"
  }
]

Changes

  • 00145cade28aRevision changes
    • info

      added the optional property ///// to the response with the status

  • 2fa29f1e745bRevision changes
    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset