entries

Changed on

Archive an entry.

post/entries/{id}/archive

Request

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

Path parameters

idinteger required

Response

Successfully archived the entry

aliasesobject
approvedAITopicboolean

Indicates if the topicAI has been approved by the user

archivedboolean
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
defaultVersionstring
deletableboolean
descriptionstring
doiSelection'USER' | 'DOCKSTORE' | 'GITHUB'

The Digital Object Identifier (DOI) to display publicly

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

Entry type

gitUrlstring
has_checkerboolean
idinteger
is_publishedboolean
lastUpdatedinteger
last_modifiedinteger
last_modified_dateinteger
metadataFromEntryEntry circular
metricsByPlatformobject
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
userIdToOrcidPutCodeobject

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

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