v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB

projects

Create project article

Create a new Article and associate it with this project

post/account/projects/{project_id}/articles

Path parameters

project_idinteger required

Project unique identifier

Request body

titlestring required

Title of article

descriptionstring

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

tagsstring[]

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

keywordsstring[]

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

referencesstring[]

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

categoriesinteger[]

List of category ids to be associated with the article(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

authorsobject[]

List of authors to be associated with the article. 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.

custom_fieldsobject

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

defined_typestring

<b>One of:</b> <code>figure</code> <code>online resource</code> <code>preprint</code> <code>book</code> <code>conference contribution</code> <code>media</code> <code>dataset</code> <code>poster</code> <code>journal contribution</code> <code>presentation</code> <code>thesis</code> <code>software</code>

fundingstring

Grant number or funding authority

licenseinteger

License id for this article.

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_doistring

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

resource_titlestring

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

Example request

{
  "title": "Test article title",
  "description": "Test description of article",
  "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
    }
  ],
  "categories": [
    1,
    10,
    11
  ],
  "categories_by_source_id": [
    "300204",
    "400207"
  ],
  "authors": [
    {
      "name": "John Doe"
    },
    {
      "id": 1000008
    }
  ],
  "custom_fields": {
    "defined_key": "value for it"
  },
  "custom_fields_list": [
    {
      "name": "key"
    }
  ],
  "defined_type": "media",
  "license": 1,
  "timeline": {
    "firstOnline": "2015-12-31",
    "publisherPublication": "2015-12-31",
    "publisherAcceptance": "2015-12-31"
  }
}

Response

Created

locationstring url required

Url for item