v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB

collections

Partially update collection

Partially update a collection by sending only the keys to change. For collections with item-type based metadata, send the keys to update inside fields:{} — keys not present are preserved. categories entries accept id (int) or source_id (string), mixed allowed (bare integers rejected). Unresolved source_id values are reported in the response warnings array. Unrecognised field names inside fields (e.g. a typo) are rejected with 422.

patch/account/collections/{collection_id}

Path parameters

collection_idinteger required

Collection Unique identifier

Request body

fundingstring

Grant number or funding authority

titlestring

Title of collection

descriptionstring

The collection description. In a publisher case, usually this is the remote collection description

articlesinteger[]

List of articles to be associated with the collection

authorsobject[]

List of authors to be associated with the collection. The list can contain the following fields: id, name, first_name, last_name, email, orcid_id. If an id is supplied, it will take priority and everything else will be ignored. For adding more authors use the specific authors endpoint.

categoriesinteger[]

List of category ids to be associated with the collection (e.g [1, 23, 33, 66])

categories_by_source_idstring[]

List of category source ids to be associated with the article, supersedes the categories property

tagsstring[]

List of tags to be associated with the collection. Keywords can be used instead

keywordsstring[]

List of tags to be associated with the collection. Tags can be used instead

referencesstring[]

List of links to be associated with the collection (e.g ["http://link1", "http://link2", "http://link3"])

custom_fieldsobject

List of key, values pairs to be associated with the collection

doistring

Not applicable for regular users. In an institutional case, make sure your group supports setting DOIs. This setting is applied by figshare via opening a ticket through our support/helpdesk system.

handlestring

Not applicable for regular users. In an institutional case, make sure your group supports setting Handles. This setting is applied by figshare via opening a ticket through our support/helpdesk system.

resource_idstring

Not applicable to regular users. In a publisher case, this is the publisher article id

resource_doistring

Not applicable to regular users. In a publisher case, this is the publisher article DOI.

resource_linkstring

Not applicable to regular users. In a publisher case, this is the publisher article link

resource_titlestring

Not applicable to regular users. In a publisher case, this is the publisher article title.

resource_versioninteger

Not applicable to regular users. In a publisher case, this is the publisher article version

group_idinteger

Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups

Example request

{
  "title": "Test collection title",
  "description": "Test description of collection",
  "articles": [
    2000001,
    2000005
  ],
  "authors": [
    {
      "name": "John Doe"
    },
    {
      "id": 20005
    }
  ],
  "categories": [
    1,
    10,
    11
  ],
  "categories_by_source_id": [
    "300204",
    "400207"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "keywords": [
    "tag1",
    "tag2"
  ],
  "references": [
    "http://figshare.com",
    "http://api.figshare.com"
  ],
  "related_materials": [
    {
      "id": 10432,
      "identifier": "10.6084/m9.figshare.1407024",
      "identifier_type": "DOI",
      "relation": "IsSupplementTo",
      "title": "Figshare for institutions brochure",
      "is_linkout": false
    }
  ],
  "custom_fields": {
    "defined_key": "value for it"
  },
  "custom_fields_list": [
    {
      "name": "key"
    }
  ],
  "timeline": {
    "firstOnline": "2015-12-31",
    "publisherPublication": "2015-12-31",
    "publisherAcceptance": "2015-12-31"
  }
}

Response

Reset Content

locationstring url required

Url for entity

warningsstring[] required

Issues encountered during the operation