workflows

Changed on

Retrieve a workflow

get/workflows/{workflowId}

Request

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

Path parameters

workflowIdinteger required

Query parameters

includestring

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

Response

default response

aliasesobject
approvedAITopicboolean

Indicates if the topicAI has been approved by the user

archivedboolean
autoGenerateDoisboolean

Whether to automatically generate DOIs for GitHub tags

checker_idinteger
conceptDoistring

The Digital Object Identifier (DOI) representing all of the versions of your workflow

conceptDoisobject

The Digital Object Identifier (DOI) representing all of the versions of your workflow

dbCreateDateinteger
dbUpdateDateinteger
defaultTestParameterFilePathstring
defaultVersionstring
deletableboolean
descriptionstring
descriptorType'SMK' | 'CWL' | 'WDL' | 'gxformat2' | 'SWL' | 'NFL' | 'service' | 'jupyter'
descriptorTypeSubclass'docker-compose' | 'helm' | 'swarm' | 'kubernetes' | 'Python' | 'R' | 'Javascript' | 'Scala' | 'Julia' | 'other' | 'n/a'
doiSelection'USER' | 'DOCKSTORE' | 'GITHUB'

The Digital Object Identifier (DOI) to display publicly

entryType'TOOL' | 'WORKFLOW' | 'SERVICE' | 'APPTOOL' | 'NOTEBOOK'

Entry type

forumUrlstring
full_workflow_pathstring
gitUrlstring
has_checkerboolean
idinteger
isCheckerboolean
is_publishedboolean
lastUpdatedinteger
last_modifiedinteger
last_modified_dateinteger
latestReleaseDateinteger

The timestamp of the most recent version control release, such as a GitHub release

metadataFromEntryWorkflow circular
metricsByPlatformobject
mode'FULL' | 'STUB' | 'HOSTED' | 'DOCKSTORE_YML'
organizationstring
pathstring
repositorystring
sourceControl'dockstore.org' | 'github.com' | 'bitbucket.org' | 'gitlab.com'
source_control_providerstring
topicstring
topicAIstring

Short description of the entry generated by AI

topicAutomaticstring

Short description of the entry gotten automatically

topicIdinteger
topicManualstring

Short description of the entry manually updated

topicSelection'AUTOMATIC' | 'MANUAL' | 'AI'

Which topic to display to the public users

trsIdstring
typestring required
userIdToOrcidPutCodeobject

The presence of the put code for a userid indicates the entry was exported to ORCID for the corresponding Dockstore user.

workflowNamestring
workflow_pathstring

Example response

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

Changes

  • e7ba6b990428Revision 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

  • 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

    • 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

    • 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

    • 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

    • 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