@datafire/figshare

v6.0.0

Published

3 years ago

DataFire integration for Figshare

Downloads

0High
0Medium
0Low

datafire

@datafire/figshare

Client library for Figshare

Installation and Usage

npm install --save @datafire/figshare

let figshare = require('@datafire/figshare').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Figshare apiv2. Using Swagger 2.0

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

figshare.oauthCallback({
  "code": ""
}, context)

Input

input object
- code required string

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

oauthRefresh

Exchange a refresh_token for an access_token

figshare.oauthRefresh(null, context)

Input

This action has no parameters

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

private_account

Account information for token/personal token

figshare.private_account(null, context)

Input

This action has no parameters

Output

output Account

private_articles_list

Get Own Articles

figshare.private_articles_list({}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit

Output

output array
- items Article

private_article_create

Create a new Article by sending article information

figshare.private_article_create({
  "Article": {
    "title": ""
  }
}, context)

Input

input object
- Article required ArticleCreate

Output

output Location

account_article_report

Return status on all reports generated for the account from the oauth credentials

figshare.account_article_report({}, context)

Input

input object
- group_id integer: A group ID to filter by

Output

output array
- items AccountReport

account_article_report_generate

Initiate a new Article Report for this Account

figshare.account_article_report_generate(null, context)

Input

This action has no parameters

Output

output AccountReport

private_articles_search

Returns a list of private articles filtered by the search parameters

figshare.private_articles_search({
  "search": {}
}, context)

Input

input object
- search required PrivateArticleSearch

Output

output array
- items Article

private_article_delete

Delete an article

figshare.private_article_delete({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_details

View a private article

figshare.private_article_details({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output ArticleCompletePrivate

private_article_update

Updating an article by passing body parameters

figshare.private_article_update({
  "Article": {},
  "article_id": 0
}, context)

Input

input object
- Article required ArticleUpdate
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_authors_list

List article authors

figshare.private_article_authors_list({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output array
- items Author

private_article_authors_add

Associate new authors with the article. This will add new authors to the list of already associated authors

figshare.private_article_authors_add({
  "Authors": {
    "authors": []
  },
  "article_id": 0
}, context)

Input

input object
- Authors required AuthorsCreator
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_authors_replace

Associate new authors with the article. This will remove all already associated authors and add these new ones

figshare.private_article_authors_replace({
  "Authors": {
    "authors": []
  },
  "article_id": 0
}, context)

Input

input object
- Authors required AuthorsCreator
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_author_delete

De-associate author from article

figshare.private_article_author_delete({
  "article_id": 0,
  "author_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier
- author_id required integer: Article Author unique identifier

Output

Output schema unknown

private_article_categories_list

List article categories

figshare.private_article_categories_list({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output array
- items Category

private_article_categories_add

Associate new categories with the article. This will add new categories to the list of already associated categories

figshare.private_article_categories_add({
  "categories": {
    "categories": []
  },
  "article_id": 0
}, context)

Input

input object
- categories required CategoriesCreator
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_categories_replace

Associate new categories with the article. This will remove all already associated categories and add these new ones

figshare.private_article_categories_replace({
  "categories": {
    "categories": []
  },
  "article_id": 0
}, context)

Input

input object
- categories required CategoriesCreator
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_category_delete

De-associate category from article

figshare.private_article_category_delete({
  "article_id": 0,
  "category_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier
- category_id required integer: Category unique identifier

Output

Output schema unknown

private_article_confidentiality_delete

Delete confidentiality settings

figshare.private_article_confidentiality_delete({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_confidentiality_details

View confidentiality settings

figshare.private_article_confidentiality_details({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output ArticleConfidentiality

private_article_confidentiality_update

Update confidentiality settings

figshare.private_article_confidentiality_update({
  "reason": {},
  "article_id": 0
}, context)

Input

input object
- reason required ConfidentialityCreator
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_embargo_delete

Will lift the embargo for the specified article

figshare.private_article_embargo_delete({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_embargo_details

View a private article embargo details

figshare.private_article_embargo_details({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output ArticleEmbargo

private_article_embargo_update

Note: setting an article under whole embargo does not imply that the article will be published when the embargo will expire. You must explicitly call the publish endpoint to enable this functionality.

figshare.private_article_embargo_update({
  "Embargo": {},
  "article_id": 0
}, context)

Input

input object
- Embargo required ArticleEmbargoUpdater
- article_id required integer: Article unique identifier

Output

Output schema unknown

private_article_files_list

List private files

figshare.private_article_files_list({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output array
- items PrivateFile

private_article_upload_initiate

Initiate new file upload within the article. Either use link to provide only an existing file that will not be uploaded on figshare or use the other 3 parameters(md5, name, size)

figshare.private_article_upload_initiate({
  "File": {},
  "article_id": 0
}, context)

Input

input object
- File required FileCreator
- article_id required integer: Article unique identifier

Output

output Location

private_article_file_delete

Complete file upload

figshare.private_article_file_delete({
  "article_id": 0,
  "file_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier
- file_id required integer: File unique identifier

Output

Output schema unknown

private_article_file

View details of file for specified article

figshare.private_article_file({
  "article_id": 0,
  "file_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier
- file_id required integer: File unique identifier

Output

output PrivateFile

private_article_upload_complete

Complete file upload

figshare.private_article_upload_complete({
  "article_id": 0,
  "file_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier
- file_id required integer: File unique identifier

Output

Output schema unknown

private_article_private_link

List private links

figshare.private_article_private_link({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output array
- items PrivateLink

private_article_private_link_create

Create new private link for this article

figshare.private_article_private_link_create({
  "article_id": 0
}, context)

Input

input object
- private_link PrivateLinkCreator
- article_id required integer: Article unique identifier

Output

output Location

private_article_private_link_delete

Disable/delete private link for this article

figshare.private_article_private_link_delete({
  "article_id": 0,
  "link_id": ""
}, context)

Input

input object
- article_id required integer: Article unique identifier
- link_id required string: Private link token

Output

Output schema unknown

private_article_private_link_update

Update existing private link for this article

figshare.private_article_private_link_update({
  "article_id": 0,
  "link_id": ""
}, context)

Input

input object
- private_link PrivateLinkCreator
- article_id required integer: Article unique identifier
- link_id required string: Private link token

Output

Output schema unknown

private_article_publish

If the whole article is under embargo, it will not be published immediatly, but when the embargo expires or is lifted.
When an article is published, a new public version will be generated. Any further updates to the article will affect the private article data. In order to make these changes publicly visible, an explicit publish operation is needed.

figshare.private_article_publish({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output Location

private_article_reserve_doi

Reserve DOI for article

figshare.private_article_reserve_doi({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output ArticleDOI

private_article_reserve_handle

Reserve Handle for article

figshare.private_article_reserve_handle({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article unique identifier

Output

output ArticleHandle

private_authors_search

Search for authors

figshare.private_authors_search({}, context)

Input

input object
- search PrivateAuthorsSearch

Output

output array
- items Author

private_author_details

View author details

figshare.private_author_details({
  "author_id": 0
}, context)

Input

input object
- author_id required integer: Author unique identifier

Output

output AuthorComplete

private_categories_list

List institution categories (including parent Categories)

figshare.private_categories_list(null, context)

Input

This action has no parameters

Output

output array
- items Category

private_collections_list

List private collections

figshare.private_collections_list({}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- order string (values: published_date, modified_date, views, shares, cites): The field by which to order. Default varies by endpoint/resource.
- order_direction string (values: asc, desc)

Output

output array
- items Collection

private_collection_create

Create a new Collection by sending collection information

figshare.private_collection_create({
  "Collection": {
    "title": ""
  }
}, context)

Input

input object
- Collection required CollectionCreate

Output

output CollectionComplete

private_collections_search

Returns a list of private Collections

figshare.private_collections_search({
  "search": {}
}, context)

Input

input object
- search required PrivateCollectionSearch

Output

output array
- items Collection

private_collection_delete

Delete n collection

figshare.private_collection_delete({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier

Output

Output schema unknown

private_collection_details

View a collection

figshare.private_collection_details({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier

Output

output CollectionComplete

private_collection_update

Update collection details

figshare.private_collection_update({
  "Collection": {},
  "collection_id": 0
}, context)

Input

input object
- Collection required CollectionUpdate
- collection_id required integer: Collection Unique identifier

Output

Output schema unknown

private_collection_articles_list

List collection articles

figshare.private_collection_articles_list({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection unique identifier

Output

output array
- items Article

private_collection_articles_add

Associate new articles with the collection. This will add new articles to the list of already associated articles

figshare.private_collection_articles_add({
  "articles": {
    "articles": []
  },
  "collection_id": 0
}, context)

Input

input object
- articles required ArticlesCreator
- collection_id required integer: Collection unique identifier

Output

output Location

private_collection_articles_replace

Associate new articles with the collection. This will remove all already associated articles and add these new ones

figshare.private_collection_articles_replace({
  "articles": {
    "articles": []
  },
  "collection_id": 0
}, context)

Input

input object
- articles required ArticlesCreator
- collection_id required integer: Collection unique identifier

Output

Output schema unknown

private_collection_article_delete

De-associate article from collection

figshare.private_collection_article_delete({
  "collection_id": 0,
  "article_id": 0
}, context)

Input

input object
- collection_id required integer: Collection unique identifier
- article_id required integer: Collection article unique identifier

Output

Output schema unknown

private_collection_authors_list

List collection authors

figshare.private_collection_authors_list({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection unique identifier

Output

output array
- items Author

private_collection_authors_add

Associate new authors with the collection. This will add new authors to the list of already associated authors

figshare.private_collection_authors_add({
  "Authors": {
    "authors": []
  },
  "collection_id": 0
}, context)

Input

input object
- Authors required AuthorsCreator
- collection_id required integer: Collection unique identifier

Output

output Location

private_collection_authors_replace

Associate new authors with the collection. This will remove all already associated authors and add these new ones

figshare.private_collection_authors_replace({
  "Authors": {
    "authors": []
  },
  "collection_id": 0
}, context)

Input

input object
- Authors required AuthorsCreator
- collection_id required integer: Collection unique identifier

Output

Output schema unknown

private_collection_author_delete

Delete collection author

figshare.private_collection_author_delete({
  "collection_id": 0,
  "author_id": 0
}, context)

Input

input object
- collection_id required integer: Collection unique identifier
- author_id required integer: Collection Author unique identifier

Output

Output schema unknown

private_collection_categories_list

List collection categories

figshare.private_collection_categories_list({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection unique identifier

Output

output array
- items Category

private_collection_categories_add

Associate new categories with the collection. This will add new categories to the list of already associated categories

figshare.private_collection_categories_add({
  "categories": {
    "categories": []
  },
  "collection_id": 0
}, context)

Input

input object
- categories required CategoriesCreator
- collection_id required integer: Collection unique identifier

Output

output Location

private_collection_categories_replace

Associate new categories with the collection. This will remove all already associated categories and add these new ones

figshare.private_collection_categories_replace({
  "categories": {
    "categories": []
  },
  "collection_id": 0
}, context)

Input

input object
- categories required CategoriesCreator
- collection_id required integer: Collection unique identifier

Output

Output schema unknown

private_collection_category_delete

De-associate category from collection

figshare.private_collection_category_delete({
  "collection_id": 0,
  "category_id": 0
}, context)

Input

input object
- collection_id required integer: Collection unique identifier
- category_id required integer: Collection category unique identifier

Output

Output schema unknown

private_collection_private_links_list

List article private links

figshare.private_collection_private_links_list({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection unique identifier

Output

output array
- items PrivateLink

private_collection_private_link_create

Create new private link

figshare.private_collection_private_link_create({
  "collection_id": 0
}, context)

Input

input object
- private_link CollectionPrivateLinkCreator
- collection_id required integer: Collection unique identifier

Output

output Location

private_collection_private_link_delete

Disable/delete private link for this collection

figshare.private_collection_private_link_delete({
  "collection_id": 0,
  "link_id": ""
}, context)

Input

input object
- collection_id required integer: Collection unique identifier
- link_id required string: Private link token

Output

Output schema unknown

private_collection_private_link_update

Update existing private link for this collection

figshare.private_collection_private_link_update({
  "collection_id": 0,
  "link_id": ""
}, context)

Input

input object
- private_link CollectionPrivateLinkCreator
- collection_id required integer: Collection unique identifier
- link_id required string: Private link token

Output

Output schema unknown

private_collection_publish

When a collection is published, a new public version will be generated. Any further updates to the collection will affect the private collection data. In order to make these changes publicly visible, an explicit publish operation is needed.

figshare.private_collection_publish({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier

Output

output Location

private_collection_reserve_doi

Reserve DOI for collection

figshare.private_collection_reserve_doi({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier

Output

output CollectionDOI

private_collection_reserve_handle

Reserve Handle for collection

figshare.private_collection_reserve_handle({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier

Output

output CollectionHandle

private_funding_search

Search for fundings

figshare.private_funding_search({}, context)

Input

input object
- search FundingSearch

Output

output array
- items FundingInformation

private_institution_details

Account institution details

figshare.private_institution_details(null, context)

Input

This action has no parameters

Output

output Institution

private_institution_accounts_list

Returns the accounts for which the account has administrative privileges (assigned and inherited).

figshare.private_institution_accounts_list({}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- is_active integer: Filter by active status
- institution_user_id string: Filter by institution_user_id
- email string: Filter by email

Output

output array
- items ShortAccount

private_institution_accounts_create

Create a new Account by sending account information

figshare.private_institution_accounts_create({
  "Account": {
    "email": "",
    "last_name": ""
  }
}, context)

Input

input object
- Account required AccountCreate

Output

Output schema unknown

private_institution_accounts_search

Returns the accounts for which the account has administrative privileges (assigned and inherited).

figshare.private_institution_accounts_search({
  "search": {}
}, context)

Input

input object
- search required InstitutionAccountsSearch

Output

output array
- items ShortAccount

private_institution_accounts_update

Update Institution Account

figshare.private_institution_accounts_update({
  "account_id": 0,
  "Account": {}
}, context)

Input

input object
- account_id required integer: Account identifier the user is associated to
- Account required AccountUpdate

Output

Output schema unknown

private_institution_articles

Get Articles from own institution. User must be administrator of the institution

figshare.private_institution_articles({}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- order string (values: published_date, modified_date, views, shares, downloads, cites): The field by which to order. Default varies by endpoint/resource.
- order_direction string (values: asc, desc)
- published_since string: Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
- modified_since string: Filter by article modified date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
- status integer: only return collections with this status
- resource_doi string: only return collections with this resource_doi
- item_type integer: Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model

Output

output array
- items Article

private_institution_groups_list

Returns the groups for which the account has administrative privileges (assigned and inherited).

figshare.private_institution_groups_list(null, context)

Input

This action has no parameters

Output

output array
- items Group

account_institution_curation

Retrieve a certain curation review by its ID

figshare.account_institution_curation({
  "curation_id": 0
}, context)

Input

input object
- curation_id required integer: ID of the curation

Output

output CurationDetail

account.institution.review.curation_id.comments.get

Retrieve a certain curation review's comments.

figshare.account.institution.review.curation_id.comments.get({
  "curation_id": 0
}, context)

Input

input object
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- curation_id required integer: ID of the curation

Output

output CurationComment

account.institution.review.curation_id.comments.post

Add a new comment to the review.

figshare.account.institution.review.curation_id.comments.post({
  "CurationComment": {
    "text": ""
  },
  "curation_id": 0
}, context)

Input

input object
- CurationComment required CurationCommentCreate
- curation_id required integer: ID of the curation

Output

Output schema unknown

account_institution_curations

Retrieve a list of curation reviews for this institution

figshare.account_institution_curations({}, context)

Input

input object
- group_id integer: Filter by the group ID
- article_id integer: Retrieve the reviews for this article
- status string (values: pending, approved, rejected, closed): Filter by the status of the review
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit

Output

output Curation

private_institution_roles_list

Returns the roles available for groups and the institution group.

figshare.private_institution_roles_list(null, context)

Input

This action has no parameters

Output

output array
- items Role

private_institution_account_group_roles

List Institution Account Group Roles

figshare.private_institution_account_group_roles({
  "account_id": 0
}, context)

Input

input object
- account_id required integer: Account identifier the user is associated to

Output

output AccountGroupRoles

private_institution_account_group_roles_create

Add Institution Account Group Roles

figshare.private_institution_account_group_roles_create({
  "Account": {},
  "account_id": 0
}, context)

Input

input object
- Account required AccountGroupRolesCreate
- account_id required integer: Account identifier the user is associated to

Output

Output schema unknown

private_institution_account_group_role_delete

Delete Institution Account Group Role

figshare.private_institution_account_group_role_delete({
  "account_id": 0,
  "group_id": 0,
  "role_id": 0
}, context)

Input

input object
- account_id required integer: Account identifier for which to remove the role
- group_id required integer: Group identifier for which to remove the role
- role_id required integer: Role identifier

Output

Output schema unknown

private_account_institution_user

Retrieve institution user information using the account_id

figshare.private_account_institution_user({
  "account_id": 0
}, context)

Input

input object
- account_id required integer: Account identifier the user is associated to

Output

output User

private_licenses_list

This is a private endpoint that requires OAuth. It will return a list with figshare public licenses AND licenses defined for account's institution.

figshare.private_licenses_list(null, context)

Input

This action has no parameters

Output

output array
- items License

private_projects_list

List private projects

figshare.private_projects_list({}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- order string (values: published_date, modified_date, views): The field by which to order.
- order_direction string (values: asc, desc)
- storage string (values: group, individual): only return collections from this institution
- roles string: Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".

Output

output array
- items ProjectPrivate

private_project_create

Create a new project

figshare.private_project_create({
  "Project": {
    "title": ""
  }
}, context)

Input

input object
- Project required ProjectCreate

Output

output Location

private_projects_search

Search inside the private projects

figshare.private_projects_search({}, context)

Input

input object
- search ProjectsSearch

Output

output array
- items ProjectPrivate

private_project_delete

A project can be deleted only if: - it is not public - it does not have public articles.

When an individual project is deleted, all the articles are moved to my data of each owner.

When a group project is deleted, all the articles and files are deleted as well. Only project owner, group admin and above can delete a project.

figshare.private_project_delete({
  "project_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier

Output

Output schema unknown

private_project_details

View a private project

figshare.private_project_details({
  "project_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier

Output

output ProjectCompletePrivate

private_project_update

Updating an project by passing body parameters

figshare.private_project_update({
  "Project": {},
  "project_id": 0
}, context)

Input

input object
- Project required ProjectUpdate
- project_id required integer: Project unique identifier

Output

Output schema unknown

private_project_articles_list

List project articles

figshare.private_project_articles_list({
  "project_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit

Output

output array
- items Article

private_project_articles_create

Create a new Article and associate it with this project

figshare.private_project_articles_create({
  "Article": {
    "title": ""
  },
  "project_id": 0
}, context)

Input

input object
- Article required ArticleCreate
- project_id required integer: Project unique identifier
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit

Output

output Location

private_project_article_delete

Delete project article

figshare.private_project_article_delete({
  "project_id": 0,
  "article_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier
- article_id required integer: Project Article unique identifier

Output

Output schema unknown

private_project_article_details

Project article details

figshare.private_project_article_details({
  "project_id": 0,
  "article_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier
- article_id required integer: Project Article unique identifier

Output

output ProjectArticle

private_project_article_files

List article files

figshare.private_project_article_files({
  "project_id": 0,
  "article_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier
- article_id required integer: Project Article unique identifier

Output

output array
- items PrivateFile

private_project_article_file

Project article file details

figshare.private_project_article_file({
  "project_id": 0,
  "article_id": 0,
  "file_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier
- article_id required integer: Project Article unique identifier
- file_id required integer: File unique identifier

Output

output PrivateFile

private_project_collaborators_list

List Project collaborators and invited users

figshare.private_project_collaborators_list({
  "project_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier

Output

output array
- items ProjectCollaborator

private_project_collaborators_invite

Invite users to collaborate on project or view the project

figshare.private_project_collaborators_invite({
  "Collaborator": {
    "role_name": ""
  },
  "project_id": 0
}, context)

Input

input object
- Collaborator required ProjectCollaboratorInvite
- project_id required integer: Project unique identifier

Output

output ResponseMessage

private_project_collaborator__Delete

Remove project collaborator

figshare.private_project_collaborator__Delete({
  "project_id": 0,
  "user_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier
- user_id required integer: User unique identifier

Output

Output schema unknown

private_project_leave

Please note: project's owner cannot leave the project.

figshare.private_project_leave({
  "project_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier

Output

Output schema unknown

private_project_notes_list

List project notes

figshare.private_project_notes_list({
  "project_id": 0
}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- project_id required integer: Project unique identifier

Output

output array
- items ProjectNote

private_project_notes_create

Create a new project note

figshare.private_project_notes_create({
  "Note": {
    "text": ""
  },
  "project_id": 0
}, context)

Input

input object
- Note required ProjectNoteCreate
- project_id required integer: Project unique identifier

Output

output Location

private_project_note_delete

Delete project note

figshare.private_project_note_delete({
  "project_id": 0,
  "note_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier
- note_id required integer: Note unique identifier

Output

Output schema unknown

private_project_note

Project note details

figshare.private_project_note({
  "project_id": 0,
  "note_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier
- note_id required integer: Note unique identifier

Output

output ProjectNotePrivate

private_project_note_update

Update project note

figshare.private_project_note_update({
  "Note": {
    "text": ""
  },
  "project_id": 0,
  "note_id": 0
}, context)

Input

input object
- Note required ProjectNoteCreate
- project_id required integer: Project unique identifier
- note_id required integer: Note unique identifier

Output

Output schema unknown

private_project_publish

Publish a project. Possible after all items inside it are public

figshare.private_project_publish({
  "project_id": 0
}, context)

Input

input object
- project_id required integer: Project unique identifier

Output

output ResponseMessage

articles_list

Returns a list of public articles

figshare.articles_list({}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- order string (values: published_date, modified_date, views, shares, downloads, cites): The field by which to order. Default varies by endpoint/resource.
- order_direction string (values: asc, desc)
- institution integer: only return articles from this institution
- published_since string: Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
- modified_since string: Filter by article modified date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
- group integer: only return articles from this group
- resource_doi string: only return articles with this resource_doi
- item_type integer: Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
- doi string: only return articles with this doi
- handle string: only return articles with this handle

Output

output array
- items Article

articles_search

Returns a list of public articles, filtered by the search parameters

figshare.articles_search({}, context)

Input

input object
- search ArticleSearch

Output

output array
- items Article

article_details

View an article

figshare.article_details({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article Unique identifier

Output

output ArticleComplete

article_files

Files list for article

figshare.article_files({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article Unique identifier

Output

output array
- items PublicFile

article_file_details

File by id

figshare.article_file_details({
  "article_id": 0,
  "file_id": 0
}, context)

Input

input object
- article_id required integer: Article Unique identifier
- file_id required integer: File Unique identifier

Output

output PublicFile

article_versions

List public article versions

figshare.article_versions({
  "article_id": 0
}, context)

Input

input object
- article_id required integer: Article Unique identifier

Output

output array
- items ArticleVersions

article_version_details

Article with specified version

figshare.article_version_details({
  "article_id": 0,
  "v_number": 0
}, context)

Input

input object
- article_id required integer: Article Unique identifier
- v_number required integer: Article Version Number

Output

output ArticleComplete

article_version_confidentiality

Confidentiality for article version

figshare.article_version_confidentiality({
  "article_id": 0,
  "v_number": 0
}, context)

Input

input object
- article_id required integer: Article Unique identifier
- v_number required integer: Version Number

Output

output ArticleConfidentiality

article_version_embargo

Embargo for article version

figshare.article_version_embargo({
  "article_id": 0,
  "v_number": 0
}, context)

Input

input object
- article_id required integer: Article Unique identifier
- v_number required integer: Version Number

Output

output ArticleEmbargo

categories_list

Returns a list of public categories

figshare.categories_list(null, context)

Input

This action has no parameters

Output

output array
- items Category

collections_list

Returns a list of public collections

figshare.collections_list({}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- order string (values: published_date, modified_date, views, shares, cites): The field by which to order. Default varies by endpoint/resource.
- order_direction string (values: asc, desc)
- institution integer: only return collections from this institution
- published_since string: Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
- modified_since string: Filter by collection modified date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
- group integer: only return collections from this group
- resource_doi string: only return collections with this resource_doi
- doi string: only return collections with this doi
- handle string: only return collections with this handle

Output

output array
- items Collection

collections_search

Returns a list of public collections

figshare.collections_search({}, context)

Input

input object
- search CollectionSearch

Output

output array
- items Collection

collection_details

View a collection

figshare.collection_details({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier

Output

output CollectionComplete

collection_articles

Returns a list of public collection articles

figshare.collection_articles({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit

Output

output array
- items Article

collection_versions

Returns a list of public collection Versions

figshare.collection_versions({
  "collection_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier

Output

output array
- items CollectionVersions

collection_version_details

View details for a certain version of a collection

figshare.collection_version_details({
  "collection_id": 0,
  "version_id": 0
}, context)

Input

input object
- collection_id required integer: Collection Unique identifier
- version_id required integer: Version Number

Output

output CollectionComplete

file_download

Starts the download of a file

figshare.file_download({
  "file_id": 0
}, context)

Input

input object
- file_id required integer

Output

Output schema unknown

institution_hrfeed_upload

More info in the HR Feed section

figshare.institution_hrfeed_upload({}, context)

Input

input object
- hrfeed string, object: You can find an example in the Hr Feed section
  - content string
  - encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
  - contentType string
  - filename string

Output

output ResponseMessage

institution_articles

Returns a list of articles belonging to the institution

figshare.institution_articles({
  "institution_string_id": "",
  "resource_id": "",
  "filename": ""
}, context)

Input

input object
- institution_string_id required string
- resource_id required string
- filename required string

Output

output array
- items Article

licenses_list

Returns a list of public licenses

figshare.licenses_list(null, context)

Input

This action has no parameters

Output

output array
- items License

projects_list

Returns a list of public projects

figshare.projects_list({}, context)

Input

input object
- page integer: Page number. Used for pagination with page_size
- page_size integer: The number of results included on a page. Used for pagination with page
- limit integer: Number of results included on a page. Used for pagination with query
- offset integer: Where to start the listing(the offset of the first result). Used for pagination with limit
- order string (values: published_date, modified_date, views): The field by which to order. Default varies by endpoint/resource.
- order_direction string (values: asc, desc)
- institution integer: only return collections from this institution
- published_since string: Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
- group integer: only return collections from this group

Output

output array
- items Project

projects_search

Returns a list of public articles

figshare.projects_search({}, context)

Input

input object
- search ProjectsSearch

Output

output array
- items Project

project_details

View a project

figshare.project_details({
  "project_id": 0
}, context)

Input

input object
- project_id required integer: Project Unique identifier

Output

output ProjectComplete

project_articles

List articles in project

figshare.project_articles({
  "project_id": 0
}, context)

Input

input object
- project_id required integer: Project Unique identifier

Output

output array
- items Article

Definitions

Account

Account object
- active integer: Account activity status
- created_date string: Date when account was created
- email string: User email
- first_name string: First Name
- group_id integer: Account group id
- id integer: Account id
- institution_id integer: Account institution
- institution_user_id string: Account institution user id
- last_name string: Last Name
- maximum_file_size integer: Maximum upload size for account
- modified_date string: Date of last account modification
- pending_quota_request boolean: True if a quota request is pending
- quota integer: Account quota
- used_quota integer: Account total used quota
- used_quota_private integer: Account used private quota
- used_quota_public integer: Account public used quota

AccountCreate

AccountCreate object
- email required string: Email of account
- first_name string: First Name
- group_id integer: Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups
- institution_user_id string: Institution user id
- is_active boolean: Is account active
- last_name required string: Last Name
- quota integer: Account quota
- symplectic_user_id string: Symplectic user id

AccountGroupRoles

AccountGroupRoles object

AccountGroupRolesCreate

AccountGroupRolesCreate object

AccountReport

AccountReport object
- account_id integer: The ID of the account which generated this report.
- created_date string: Date when the AccountReport was requested
- download_url string: The download link for the generated XLSX
- group_id integer: The group ID that was used to filter the report, if any.
- id integer: A unique ID for the AccountRecord
- status string (values: missing, pending, done): Status of the report

AccountUpdate

AccountUpdate object
- group_id integer: Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups
- is_active boolean: Is account active

Article

Article object
- defined_type integer: Type of article identificator
- defined_type_name string: Name of the article type identificator
- doi string: DOI
- group_id number: Group ID
- handle string: Handle
- id integer: Unique identifier for article
- published_date string: Posted date
- thumb string: Thumbnail image
- timeline Timeline
- title string: Title of article
- url string: Api endpoint for article
- url_private_api string: Private Api endpoint for article
- url_private_html string: Private site endpoint for article
- url_public_api string: Public Api endpoint for article
- url_public_html string: Public site endpoint for article

ArticleComplete

ArticleComplete object
- authors array: List of article authors
  - items Author
- custom_fields array: List of custom fields values
  - items CustomArticleField
- figshare_url string: Article public url
- files array: List of article files
  - items PublicFile
- resource_doi string: Article DOI
- resource_title string: Article resource title
- categories array: List of categories selected for the article
  - items Category
- citation string: Article citation
- confidential_reason string: Confidentiality reason
- created_date string: Date when article was created
- description string: Article description
- embargo_date string: Date when embargo lifts
- embargo_reason string: Reason for embargo
- embargo_type string: Article embargo
- funding string: Article funding
- funding_list array
  - items integer
- has_linked_file boolean: True if any files are linked to the article
- is_active boolean: True if article is active
- is_confidential boolean: Article Confidentiality
- is_embargoed boolean: True if article is embargoed
- is_metadata_record boolean: True if article has no files
- is_public boolean: True if article is published
- license License
- metadata_reason string: Article metadata reason
- modified_date string: Date when article was last modified
- references array: List of references
  - items string
- size integer: Article size
- status string: Article status
- tags array: List of article tags
  - items string
- version integer: Article version
- defined_type integer: Type of article identificator
- defined_type_name string: Name of the article type identificator
- doi string: DOI
- group_id number: Group ID
- handle string: Handle
- id integer: Unique identifier for article
- published_date string: Posted date
- thumb string: Thumbnail image
- timeline Timeline
- title string: Title of article
- url string: Api endpoint for article
- url_private_api string: Private Api endpoint for article
- url_private_html string: Private site endpoint for article
- url_public_api string: Public Api endpoint for article
- url_public_html string: Public site endpoint for article

ArticleCompletePrivate

ArticleCompletePrivate object
- group_resource_id string: Group resource id
- authors array: List of article authors
  - items Author
- custom_fields array: List of custom fields values
  - items CustomArticleField
- figshare_url string: Article public url
- files array: List of article files
  - items PublicFile
- resource_doi string: Article DOI
- resource_title string: Article resource title
- categories array: List of categories selected for the article
  - items Category
- citation string: Article citation
- confidential_reason string: Confidentiality reason
- created_date string: Date when article was created
- description string: Article description
- embargo_date string: Date when embargo lifts
- embargo_reason string: Reason for embargo
- embargo_type string: Article embargo
- funding string: Article funding
- funding_list array
  - items integer
- has_linked_file boolean: True if any files are linked to the article
- is_active boolean: True if article is active
- is_confidential boolean: Article Confidentiality
- is_embargoed boolean: True if article is embargoed
- is_metadata_record boolean: True if article has no files
- is_public boolean: True if article is published
- license License
- metadata_reason string: Article metadata reason
- modified_date string: Date when article was last modified
- references array: List of references
  - items string
- size integer: Article size
- status string: Article status
- tags array: List of article tags
  - items string
- version integer: Article version
- defined_type integer: Type of article identificator
- defined_type_name string: Name of the article type identificator
- doi string: DOI
- group_id number: Group ID
- handle string: Handle
- id integer: Unique identifier for article
- published_date string: Posted date
- thumb string: Thumbnail image
- timeline Timeline
- title string: Title of article
- url string: Api endpoint for article
- url_private_api string: Private Api endpoint for article
- url_private_html string: Private site endpoint for article
- url_public_api string: Public Api endpoint for article
- url_public_html string: Public site endpoint for article

ArticleConfidentiality

ArticleConfidentiality object
- is_confidential boolean: True if article is confidential
- reason string: Reason for confidentiality

ArticleCreate

ArticleCreate object
- authors array: 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. No more than 10 authors. For adding more authors use the specific authors endpoint.
  - items object
- categories array: List of category ids to be associated with the article(e.g [1, 23, 33, 66])
  - items integer
- custom_fields object: List of key, values pairs to be associated with the article
- defined_type string: One of: figure online resource preprint book conference contribution media dataset poster journal contribution presentation thesis software
- description string: The article description. In a publisher case, usually this is the remote article description
- doi string: 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.
- funding string: Grant number or funding authority
- funding_list array: Funding creation / update items
  - items FundingCreate
- group_id integer: Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups
- handle string: 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.
- keywords array: List of tags to be associated with the article. Tags can be used instead
  - items string
- license integer: License id for this article.
- references array: List of links to be associated with the article (e.g ["http://link1", "http://link2", "http://link3"])
  - items string
- resource_doi string: Not applicable to regular users. In a publisher case, this is the publisher article DOI.
- resource_title string: Not applicable to regular users. In a publisher case, this is the publisher article title.
- tags array: List of tags to be associated with the article. Keywords can be used instead
  - items string
- timeline TimelineUpdate
- title required string: Title of article

ArticleDOI

ArticleDOI object
- doi string: Reserved DOI

ArticleEmbargo

ArticleEmbargo object
- embargo_date string: Date when embargo lifts
- embargo_reason string: Reason for embargo
- embargo_type string: Embargo type
- is_embargoed boolean: True if embargoed

ArticleEmbargoUpdater

ArticleEmbargoUpdater object
- embargo_date string: Date when the embargo expires and the article gets published
- embargo_reason string: Reason for setting embargo
- embargo_type string (values: article, file): Embargo can be enabled at the article or the file level. Possible values: article, file
- is_embargoed boolean: Embargo status

ArticleHandle

ArticleHandle object
- handle string: Reserved

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/figshare

Installation and Usage

Description

Actions

oauthCallback

Input

Output

oauthRefresh

Input

Output

private_account

Input

Output

private_articles_list

Input

Output

private_article_create

Input

Output

account_article_report

Input

Output

account_article_report_generate

Input

Output

private_articles_search

Input

Output

private_article_delete

Input

Output

private_article_details

Input

Output

private_article_update

Input

Output

private_article_authors_list

Input

Output

private_article_authors_add

Input

Output

private_article_authors_replace

Input

Output

private_article_author_delete

Input

Output

private_article_categories_list

Input

Output

private_article_categories_add

Input

Output

private_article_categories_replace

Input

Output

private_article_category_delete

Input

Output

private_article_confidentiality_delete

Input

Output

private_article_confidentiality_details

Input

Output

private_article_confidentiality_update

Input

Output

private_article_embargo_delete

Input

Output

private_article_embargo_details