organizations

Update a collection.

Update a collection. Currently only name, display name, description, and topic can be updated.

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

Path parameters

organizationIdinteger required

Organization ID.

collectionIdinteger required

Collection ID.

Request body

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 request

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

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

Changed in 6 of the 51 revisions of this API.51314

    • added the new optional request property ////

      new-optional-request-property

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

      response-optional-property-added

    • added the new optional request property ////

      new-optional-request-property

    • added the new optional request property ////

      new-optional-request-property

    • added the new optional request property //

      new-optional-request-property

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

  • 5b6e0475c79a213See the full diff
    • the response property's maxLength was increased from 50 to 90 for the response status

      response-property-max-length-increased

    • the response property's maxLength was increased from 39 to 90 for the response status

      response-property-max-length-increased

    • changed the pattern of the request property from [a-zA-Z](-?[a-zA-Z\d]){0,38} to [a-zA-Z](-?[a-zA-Z\d]){0,89}

      request-property-pattern-changed

    • the request property's maxLength was increased from 50 to 90

      request-property-max-length-increased

    • the request property's maxLength was increased from 39 to 90

      request-property-max-length-increased

    • the response's property pattern was changed from [a-zA-Z](-?[a-zA-Z\d]){0,38} to [a-zA-Z](-?[a-zA-Z\d]){0,89} for the status

      response-property-pattern-changed

    • added the new optional request property

      new-optional-request-property

    • added the optional property to the response with the status

      response-optional-property-added

    • the request property's maxLength was set to 255

      request-property-max-length-set

  • 7a89c3c933f13111See the full diff
    • the request property's maxLength was decreased to 50

      request-property-max-length-decreased

    • the request property's maxLength was decreased to 39

      request-property-max-length-decreased

    • the response property's maxLength was unset from 255 for the response status

      response-property-max-length-unset

    • changed the pattern of the request property from [a-zA-Z](-?[a-zA-Z\d]){0,89} to [a-zA-Z](-?[a-zA-Z\d]){0,38}

      request-property-pattern-changed

    • removed the request property ////

      request-property-removed

    • removed the request property ////

      request-property-removed

    • removed the request property ////

      request-property-removed

    • removed the request property //

      request-property-removed

    • removed the request property

      request-property-removed

    • removed the optional property //// from the response with the status

      response-optional-property-removed

    • removed the optional property //// from the response with the status

      response-optional-property-removed

    • removed the optional property //// from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • the response's property pattern was changed from [a-zA-Z](-?[a-zA-Z\d]){0,89} to [a-zA-Z](-?[a-zA-Z\d]){0,38} for the status

      response-property-pattern-changed

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog