workflows

Changed on

Return paginated versions in an entry. Max pagination is 100 versions.

get/workflows/{workflowId}/workflowVersions

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/workflows/{workflowId}/workflowVersions
  • Auth
    HTTP bearer

Path parameters

workflowIdinteger required

id of the workflow

Query parameters

limitinteger
offsetinteger
sortColstring

column used to sort versions. if omitted, the webservice determines the sort order, currently default version first

sortOrderstring
includestring

Comma-delimited list of fields to include: validations, aliases, images, authors, metrics

Response

Get workflow versions in an entry. Default is 100 versions

aiTopicProcessedboolean
aliasesobject
authorstring
commitIDstring
dbUpdateDateinteger
descriptionSource'README' | 'CUSTOM_README' | 'DESCRIPTOR'
dirtyBitboolean
doiStatus'NOT_REQUESTED' | 'REQUESTED' | 'CREATED'
doiURLstring
doisobject

The DOIs for the version of the entry

emailstring
frozenboolean
hiddenboolean
idinteger
kernelImagePathstring

User-specified notebook kernel image reference

last_modifiedinteger
legacyVersionboolean
metricsByPlatformobject
namestring required

Implementation specific, can be a quay.io or docker hub tag name

readMePathstring
referencestring required

git commit/tag/branch

referenceType'COMMIT' | 'TAG' | 'BRANCH' | 'NOT_APPLICABLE' | 'UNSET'
syncedboolean
userFilesstring[]
validboolean
verifiedboolean
verifiedPlatformsstring[]

Verified platforms for the version

verifiedSourcestring
verifiedSourcesstring[]
workflow_pathstring
workingDirectorystring

Example response

[
  {
    "name": "latest",
    "reference": "master"
  }
]

Changes

  • e7ba6b990428Revision changes
    • info

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

  • 58d7abe5af40Revision changes
    • warning

      added the new YEAR enum value to the ///////// response property for the response status

    • warning

      added the new YEAR enum value to the ///////// response property for the response status

    • warning

      added the new YEAR enum value to the ///////// response property for the response status

    • 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