organizations

Update a collection's description.

Changed on

Update a collection's description. Description in markdown.

put/organizations/{organizationId}/collections/{collectionId}/description

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/organizations/{organizationId}/collections/{collectionId}/description
  • Auth
    HTTP bearer

Path parameters

organizationIdinteger required

Organization ID.

collectionIdinteger required

Collection ID.

Request body */*

string required

Response

default response

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

  • ed2eca881e4cRevision changes
    • info

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

    • info

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

    • info

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