{
"openapi": "3.0.3",
"info": {
"title": "Figshare API",
"description": "Figshare API v2 - Full REST API documentation for managing articles, collections, projects and more.",
"version": "2.0",
"contact": {
"name": "Figshare Support",
"url": "https://support.figshare.com/support/home"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"servers": [
{
"url": "https://api.figshare.com/v2"
}
],
"paths": {
"/altmetric/institutions": {
"get": {
"tags": [
"altmetric"
],
"summary": "List Altmetric Institutions",
"description": "Returns a list of institutions available for Altmetric reporting",
"operationId": "altmetric_institutions_list",
"x-internal": true,
"parameters": [
{
"name": "offset",
"in": "query",
"description": "Where to start the listing. The offset of the first item.",
"schema": {
"minimum": 0,
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "OK. An array of Altmetric institutions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AltmetricInstitution"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
}
}
},
"/articles": {
"get": {
"tags": [
"articles"
],
"summary": "Public Articles",
"description": "Returns a list of public articles",
"operationId": "articles_list",
"parameters": [
{
"name": "X-Cursor",
"in": "header",
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
},
{
"name": "order",
"in": "query",
"description": "The field by which to order. Default varies by endpoint/resource.",
"schema": {
"type": "string",
"default": "published_date",
"enum": [
"published_date",
"created_date",
"modified_date",
"views",
"shares",
"downloads",
"cites"
]
}
},
{
"name": "order_direction",
"in": "query",
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "institution",
"in": "query",
"description": "only return articles from this institution",
"schema": {
"type": "integer"
}
},
{
"name": "published_since",
"in": "query",
"description": "Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ",
"schema": {
"type": "string"
}
},
{
"name": "modified_since",
"in": "query",
"description": "Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ",
"schema": {
"type": "string"
}
},
{
"name": "group",
"in": "query",
"description": "only return articles from this group",
"schema": {
"type": "integer"
}
},
{
"name": "resource_doi",
"in": "query",
"description": "Deprecated by related materials. Only return articles with this resource_doi",
"schema": {
"type": "string"
}
},
{
"name": "item_type",
"in": "query",
"description": "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",
"schema": {
"type": "integer"
}
},
{
"name": "doi",
"in": "query",
"description": "only return articles with this doi",
"schema": {
"type": "string"
}
},
{
"name": "handle",
"in": "query",
"description": "only return articles with this handle",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK. An array of articles",
"headers": {
"X-Cursor": {
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"422": {
"description": "Unprocessable Entity. Syntax is correct but one of the parameters isn't correctly processed",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/articles/search": {
"post": {
"tags": [
"articles"
],
"summary": "Public Articles Search",
"description": "Returns a list of public articles, filtered by the search parameters",
"operationId": "articles_search",
"parameters": [
{
"name": "X-Cursor",
"in": "header",
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleSearch"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK. An array of articles",
"headers": {
"X-Cursor": {
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleWithProject"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"422": {
"description": "Unprocessable Entity. Syntax is correct but one of the parameters isn't correctly processed",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-codegen-request-body-name": "search"
}
},
"/articles/{article_id}": {
"get": {
"tags": [
"articles"
],
"summary": "View article details",
"description": "View an article",
"operationId": "article_details",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleComplete"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Article"
}
},
"/articles/{article_id}/versions": {
"get": {
"tags": [
"articles"
],
"summary": "List article versions",
"description": "List public article versions",
"operationId": "article_versions",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article version representations",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleVersions"
}
}
}
}
},
"400": {
"description": "Bad Request. Article ID must be an integer and bigger than 0.",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Article"
}
},
"/articles/{article_id}/versions/{version_id}": {
"get": {
"tags": [
"articles"
],
"summary": "Article details for version",
"description": "Article with specified version",
"operationId": "article_version_details",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Article Version Number",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleComplete"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Article"
}
},
"/articles/{article_id}/versions/{version_id}/files": {
"get": {
"tags": [
"articles"
],
"summary": "Public Article version files",
"description": "Article version file details",
"operationId": "article_version_files",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Article Version Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. List of article files",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicFile"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Article files"
}
},
"/articles/{article_id}/download": {
"get": {
"tags": [
"articles"
],
"summary": "Public Article Download",
"description": "Download files from a public article preserving the folder structure",
"operationId": "public_article_download",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "folder_path",
"in": "query",
"description": "Folder path to download. If not provided, all files from the article will be downloaded",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Article"
}
},
"/articles/{article_id}/versions/{version_id}/download": {
"get": {
"tags": [
"articles"
],
"summary": "Public Article Version Download",
"description": "Download files from a certain version of an public article preserving the folder structure",
"operationId": "public_article_version_download",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Version Number",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "folder_path",
"in": "query",
"description": "Folder path to download. If not provided, all files from the article will be downloaded",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Article"
}
},
"/articles/{article_id}/versions/{version_id}/embargo": {
"get": {
"tags": [
"articles"
],
"summary": "Public Article Embargo for article version",
"description": "Embargo for article version",
"operationId": "article_version_embargo",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Version Number",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Embargo representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleEmbargo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/articles/{article_id}/versions/{version_id}/confidentiality": {
"get": {
"tags": [
"articles"
],
"summary": "Public Article Confidentiality for article version",
"description": "Confidentiality for article version. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.",
"operationId": "article_version_confidentiality",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Version Number",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Confidentiality representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleConfidentiality"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/articles/{article_id}/files": {
"get": {
"tags": [
"articles"
],
"summary": "List article files",
"description": "Files list for article",
"operationId": "article_files",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. List of article files",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicFile"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Article files"
}
},
"/articles/{article_id}/files/{file_id}": {
"get": {
"tags": [
"articles"
],
"summary": "Article file details",
"description": "File by id",
"operationId": "article_file_details",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "file_id",
"in": "path",
"description": "File Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. File representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicFile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Article files"
}
},
"/account/articles/search": {
"post": {
"tags": [
"articles"
],
"summary": "Private Articles search",
"description": "Returns a list of private articles filtered by the search parameters",
"operationId": "private_articles_search",
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateArticleSearch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK. An array of articles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleWithProject"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "search"
}
},
"/account/articles": {
"get": {
"tags": [
"articles"
],
"summary": "Private Articles",
"description": "Get Own Articles",
"operationId": "private_articles_list",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of articles belonging to the account",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
},
"post": {
"tags": [
"articles"
],
"summary": "Create new Article",
"description": "Create a new Article by sending article information",
"operationId": "private_article_create",
"requestBody": {
"description": "Article description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWarnings"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article",
"x-codegen-request-body-name": "Article"
}
},
"/account/articles/{article_id}": {
"get": {
"tags": [
"articles"
],
"summary": "Article details",
"description": "View a private article",
"operationId": "private_article_details",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleCompletePrivate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article"
},
"put": {
"tags": [
"articles"
],
"summary": "Update article",
"description": "Update an article by passing full body parameters.",
"operationId": "private_article_update",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Full article representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleUpdate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of newly created article",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWarningsUpdate"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article",
"x-codegen-request-body-name": "Article"
},
"delete": {
"tags": [
"articles"
],
"summary": "Delete article",
"description": "Delete an article",
"operationId": "private_article_delete",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article"
},
"patch": {
"tags": [
"articles"
],
"summary": "Partially update article",
"description": "Partially update an article by sending only the fields to change.",
"operationId": "private_article_partial_update",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Subset of article fields to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleUpdate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of the updated article",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWarningsUpdate"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article",
"x-codegen-request-body-name": "Article"
}
},
"/account/articles/{article_id}/embargo": {
"get": {
"tags": [
"articles"
],
"summary": "Article Embargo Details",
"description": "View a private article embargo details",
"operationId": "private_article_embargo_details",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Embargo for article",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleEmbargo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Embargo"
},
"put": {
"tags": [
"articles"
],
"summary": "Update Article Embargo",
"description": "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.",
"operationId": "private_article_embargo_update",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Embargo description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleEmbargoUpdater"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of embargo",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Embargo",
"x-codegen-request-body-name": "Embargo"
},
"delete": {
"tags": [
"articles"
],
"summary": "Delete Article Embargo",
"description": "Will lift the embargo for the specified article",
"operationId": "private_article_embargo_delete",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Embargo"
}
},
"/account/articles/{article_id}/resource": {
"post": {
"tags": [
"articles"
],
"summary": "Private Article Resource",
"description": "Edit article resource data.",
"operationId": "private_article_resource",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Resource data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Resource"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location for account article details",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"422": {
"description": "Unprocessable Entity",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "Resource"
}
},
"/account/articles/{article_id}/publish": {
"post": {
"tags": [
"articles"
],
"summary": "Private Article Publish",
"description": "- If the whole article is under embargo, it will not be published immediately, but when the embargo expires or is lifted.\n- 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.",
"operationId": "account_article_publish",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of newly published article",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/articles/{article_id}/unpublish": {
"post": {
"tags": [
"articles"
],
"summary": "Public Article Unpublish",
"description": "Allows authorized users to unpublish an article.",
"operationId": "account_article_unpublish",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Article unpublish data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleUnpublishData"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "reason"
}
},
"/account/articles/{article_id}/reserve_doi": {
"post": {
"tags": [
"articles"
],
"summary": "Private Article Reserve DOI",
"description": "Reserve DOI for article",
"operationId": "private_article_reserve_doi",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleDOI"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/articles/{article_id}/reserve_handle": {
"post": {
"tags": [
"articles"
],
"summary": "Private Article Reserve Handle",
"description": "Reserve Handle for article",
"operationId": "private_article_reserve_handle",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleHandle"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/articles/{article_id}/download": {
"get": {
"tags": [
"articles"
],
"summary": "Private Article Download",
"description": "Download files from a private article preserving the folder structure",
"operationId": "private_article_download",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "folder_path",
"in": "query",
"description": "Folder path to download. If not provided, all files from the article will be downloaded",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"403": {
"description": "Insufficient permissions",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/articles/{article_id}/versions/{version_id}": {
"put": {
"tags": [
"articles"
],
"summary": "Update article version",
"description": "Updating an article version by passing body parameters.",
"operationId": "article_version_update",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Article version identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Article description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleVersionUpdate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of newly created article",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWarningsUpdate"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Article version private updates",
"x-codegen-request-body-name": "Article"
},
"patch": {
"tags": [
"articles"
],
"summary": "Partially update article version",
"description": "Partially updating an article version by passing only the fields to change.",
"operationId": "article_version_partial_update",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Article version identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Subset of article version fields to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleVersionUpdate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of updated article version",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWarningsUpdate"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Article version private updates",
"x-codegen-request-body-name": "Article"
}
},
"/account/articles/{article_id}/versions/{version_id}/update_thumb": {
"put": {
"tags": [
"articles"
],
"summary": "Update article version thumbnail",
"description": "For a given public article version update the article thumbnail by choosing one of the associated files",
"operationId": "article_version_update_thumb",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Article version identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "File ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileId"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location for article version details",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"422": {
"description": "Unprocessable Entity",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Article version private updates",
"x-codegen-request-body-name": "FileId"
}
},
"/account/articles/{article_id}/authors": {
"get": {
"tags": [
"articles"
],
"summary": "List article authors",
"description": "List article authors",
"operationId": "private_article_authors_list",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Authors list for article",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Author"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Authors"
},
"put": {
"tags": [
"articles"
],
"summary": "Replace article authors",
"description": "Associate new authors with the article. This will remove all already associated authors and add these new ones",
"operationId": "private_article_authors_replace",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Authors description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorsCreator"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of list of authors",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request. Article ID must be an integer and bigger than 0. Author with ID Not Found.",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Authors",
"x-codegen-request-body-name": "Authors"
},
"post": {
"tags": [
"articles"
],
"summary": "Add article authors",
"description": "Associate new authors with the article. This will add new authors to the list of already associated authors",
"operationId": "private_article_authors_add",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Authors description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorsCreator"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of list of authors",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Authors",
"x-codegen-request-body-name": "Authors"
}
},
"/account/articles/{article_id}/authors/{author_id}": {
"delete": {
"tags": [
"articles"
],
"summary": "Delete article author",
"description": "De-associate author from article",
"operationId": "private_article_author_delete",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "author_id",
"in": "path",
"description": "Article Author unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Authors"
}
},
"/account/articles/{article_id}/categories": {
"get": {
"tags": [
"articles"
],
"summary": "List article categories",
"description": "List article categories",
"operationId": "private_article_categories_list",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article categories",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Category"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Categories"
},
"put": {
"tags": [
"articles"
],
"summary": "Replace article categories",
"description": "Associate new categories with the article. This will remove all already associated categories and add these new ones",
"operationId": "private_article_categories_replace",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoriesCreator"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Categories",
"x-codegen-request-body-name": "categories"
},
"post": {
"tags": [
"articles"
],
"summary": "Add article categories",
"description": "Associate new categories with the article. This will add new categories to the list of already associated categories",
"operationId": "private_article_categories_add",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoriesCreator"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Categories",
"x-codegen-request-body-name": "categories"
}
},
"/account/articles/{article_id}/categories/{category_id}": {
"delete": {
"tags": [
"articles"
],
"summary": "Delete article category",
"description": "De-associate category from article",
"operationId": "private_article_category_delete",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "category_id",
"in": "path",
"description": "Category unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Categories"
}
},
"/account/articles/{article_id}/confidentiality": {
"get": {
"tags": [
"articles"
],
"summary": "Article confidentiality details",
"description": "View confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.",
"operationId": "private_article_confidentiality_details",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article categories",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleConfidentiality"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Confidentiality - DEPRECATED"
},
"put": {
"tags": [
"articles"
],
"summary": "Update article confidentiality",
"description": "Update confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.",
"operationId": "private_article_confidentiality_update",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfidentialityCreator"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Confidentiality - DEPRECATED",
"x-codegen-request-body-name": "reason"
},
"delete": {
"tags": [
"articles"
],
"summary": "Delete article confidentiality",
"description": "Delete confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.",
"operationId": "private_article_confidentiality_delete",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Confidentiality - DEPRECATED"
}
},
"/account/articles/{article_id}/private_links": {
"get": {
"tags": [
"articles"
],
"summary": "List private links",
"description": "List private links",
"operationId": "private_article_private_link",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article private links",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Private Links"
},
"post": {
"tags": [
"articles"
],
"summary": "Create private link",
"description": "Create new private link for this article",
"operationId": "private_article_private_link_create",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateLinkCreator"
}
}
},
"required": false
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of private link",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateLinkResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"422": {
"description": "Unprocessable Entity",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Private Links",
"x-codegen-request-body-name": "private_link"
}
},
"/account/articles/{article_id}/private_links/{link_id}": {
"put": {
"tags": [
"articles"
],
"summary": "Update private link",
"description": "Update existing private link for this article",
"operationId": "private_article_private_link_update",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "link_id",
"in": "path",
"description": "Private link token",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateLinkCreator"
}
}
},
"required": false
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of private link",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"422": {
"description": "Unprocessable Entity",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Private Links",
"x-codegen-request-body-name": "private_link"
},
"delete": {
"tags": [
"articles"
],
"summary": "Disable private link",
"description": "Disable/delete private link for this article",
"operationId": "private_article_private_link_delete",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "link_id",
"in": "path",
"description": "Private link token",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Private Links"
}
},
"/account/articles/{article_id}/files": {
"get": {
"tags": [
"articles"
],
"summary": "List article files",
"description": "List private files",
"operationId": "private_article_files_list",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article files list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateFile"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Files"
},
"post": {
"tags": [
"articles"
],
"summary": "Initiate Upload",
"description": "Initiate a new file upload within the article. Either use the link property to point to an existing file that resides elsewhere and will not be uploaded to Figshare or use the other 3 parameters (md5, name, size).",
"operationId": "private_article_upload_initiate",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileCreator"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of new file",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"422": {
"description": "Unprocessable Entity. Parameters missing or incorrect",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Files",
"x-codegen-request-body-name": "File"
}
},
"/account/articles/{article_id}/files/{file_id}": {
"get": {
"tags": [
"articles"
],
"summary": "Single File",
"description": "View details of file for specified article",
"operationId": "private_article_file",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "file_id",
"in": "path",
"description": "File unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article private file",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateFile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Files"
},
"post": {
"tags": [
"articles"
],
"summary": "Complete Upload",
"description": "Complete file upload",
"operationId": "private_article_upload_complete",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "file_id",
"in": "path",
"description": "File unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Files"
},
"delete": {
"tags": [
"articles"
],
"summary": "File Delete",
"description": "Complete file upload",
"operationId": "private_article_file_delete",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "file_id",
"in": "path",
"description": "File unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Article Files"
}
},
"/account/articles/export": {
"get": {
"tags": [
"articles"
],
"summary": "Account Article Report",
"description": "Return status on all reports generated for the account from the oauth credentials",
"operationId": "account_article_report",
"parameters": [
{
"name": "group_id",
"in": "query",
"description": "A group ID to filter by",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of account report entries",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountReport"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
},
"post": {
"tags": [
"articles"
],
"summary": "Initiate a new Report",
"description": "Initiate a new Article Report for this Account. There is a limit of 1 report per day.",
"operationId": "account_article_report_generate",
"responses": {
"200": {
"description": "OK. AccountReport created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountReport"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/authors/search": {
"post": {
"tags": [
"authors"
],
"summary": "Search Authors",
"description": "Search for authors",
"operationId": "private_authors_search",
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateAuthorsSearch"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK. An array of authors",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorComplete"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "search"
}
},
"/account/authors/{author_id}": {
"get": {
"tags": [
"authors"
],
"summary": "Author details",
"description": "View author details",
"operationId": "private_author_details",
"parameters": [
{
"name": "author_id",
"in": "path",
"description": "Author unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorComplete"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/collections": {
"get": {
"tags": [
"collections"
],
"summary": "Public Collections",
"description": "Returns a list of public collections",
"operationId": "collections_list",
"parameters": [
{
"name": "X-Cursor",
"in": "header",
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
},
{
"name": "order",
"in": "query",
"description": "The field by which to order. Default varies by endpoint/resource.",
"schema": {
"type": "string",
"default": "published_date",
"enum": [
"published_date",
"created_date",
"modified_date",
"views",
"shares",
"cites"
]
}
},
{
"name": "order_direction",
"in": "query",
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "institution",
"in": "query",
"description": "only return collections from this institution",
"schema": {
"type": "integer"
}
},
{
"name": "published_since",
"in": "query",
"description": "Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD",
"schema": {
"type": "string"
}
},
{
"name": "modified_since",
"in": "query",
"description": "Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD",
"schema": {
"type": "string"
}
},
{
"name": "group",
"in": "query",
"description": "only return collections from this group",
"schema": {
"type": "integer"
}
},
{
"name": "resource_doi",
"in": "query",
"description": "only return collections with this resource_doi",
"schema": {
"type": "string"
}
},
{
"name": "doi",
"in": "query",
"description": "only return collections with this doi",
"schema": {
"type": "string"
}
},
{
"name": "handle",
"in": "query",
"description": "only return collections with this handle",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK. An array of collections",
"headers": {
"X-Cursor": {
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Collection"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"422": {
"description": "Bad Request",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/collections/search": {
"post": {
"tags": [
"collections"
],
"summary": "Public Collections Search",
"description": "Returns a list of public collections",
"operationId": "collections_search",
"parameters": [
{
"name": "X-Cursor",
"in": "header",
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionSearch"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK. An array of collections",
"headers": {
"X-Cursor": {
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Collection"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"422": {
"description": "Bad Request",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-codegen-request-body-name": "search"
}
},
"/collections/{collection_id}": {
"get": {
"tags": [
"collections"
],
"summary": "Collection details",
"description": "View a collection",
"operationId": "collection_details",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Collection representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionComplete"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Collection"
}
},
"/collections/{collection_id}/versions": {
"get": {
"tags": [
"collections"
],
"summary": "Collection Versions list",
"description": "Returns a list of public collection Versions",
"operationId": "collection_versions",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of versions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionVersions"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Collection"
}
},
"/collections/{collection_id}/versions/{version_id}": {
"get": {
"tags": [
"collections"
],
"summary": "Collection Version details",
"description": "View details for a certain version of a collection",
"operationId": "collection_version_details",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"description": "Version Number",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Collection for that version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionComplete"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-subcategory": "Public Collection"
}
},
"/collections/{collection_id}/articles": {
"get": {
"tags": [
"collections"
],
"summary": "Public Collection Articles",
"description": "Returns a list of public collection articles",
"operationId": "collection_articles",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of articles belonging to the collection",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"422": {
"description": "Bad Request",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/account/collections": {
"get": {
"tags": [
"collections"
],
"summary": "Private Collections List",
"description": "List private collections",
"operationId": "private_collections_list",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
},
{
"name": "order",
"in": "query",
"description": "The field by which to order. Default varies by endpoint/resource.",
"schema": {
"type": "string",
"default": "published_date",
"enum": [
"published_date",
"modified_date",
"views",
"shares",
"cites"
]
}
},
{
"name": "order_direction",
"in": "query",
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
}
],
"responses": {
"200": {
"description": "OK. An array of collections",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Collection"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
},
"post": {
"tags": [
"collections"
],
"summary": "Create collection",
"description": "Create a new Collection by sending collection information",
"operationId": "private_collection_create",
"requestBody": {
"description": "Collection description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWarnings"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection",
"x-codegen-request-body-name": "Collection"
}
},
"/account/collections/{collection_id}": {
"get": {
"tags": [
"collections"
],
"summary": "Collection details",
"description": "View a collection",
"operationId": "private_collection_details",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Collection representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionCompletePrivate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection"
},
"put": {
"tags": [
"collections"
],
"summary": "Update collection",
"description": "Update a collection by passing full body parameters.",
"operationId": "private_collection_update",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Collection description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionUpdate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of collection",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWarningsUpdate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection",
"x-codegen-request-body-name": "Collection"
},
"delete": {
"tags": [
"collections"
],
"summary": "Delete collection",
"description": "Delete n collection",
"operationId": "private_collection_delete",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection"
},
"patch": {
"tags": [
"collections"
],
"summary": "Partially update collection",
"description": "Partially update a collection by sending only the fields to change.",
"operationId": "private_collection_patch",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Subset of collection fields to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionUpdate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of collection",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWarningsUpdate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection",
"x-codegen-request-body-name": "Collection"
}
},
"/account/collections/search": {
"post": {
"tags": [
"collections"
],
"summary": "Private Collections Search",
"description": "Returns a list of private Collections",
"operationId": "private_collections_search",
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateCollectionSearch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK. An array of collections",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Collection"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "search"
}
},
"/account/collections/{collection_id}/reserve_doi": {
"post": {
"tags": [
"collections"
],
"summary": "Private Collection Reserve DOI",
"description": "Reserve DOI for collection",
"operationId": "private_collection_reserve_doi",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionDOI"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/collections/{collection_id}/reserve_handle": {
"post": {
"tags": [
"collections"
],
"summary": "Private Collection Reserve Handle",
"description": "Reserve Handle for collection",
"operationId": "private_collection_reserve_handle",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionHandle"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/collections/{collection_id}/resource": {
"post": {
"tags": [
"collections"
],
"summary": "Private Collection Resource",
"description": "Edit collection resource data.",
"operationId": "private_collection_resource",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Resource data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Resource"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location for account collection details",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"422": {
"description": "Unprocessable Entity",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "Resource"
}
},
"/account/collections/{collection_id}/publish": {
"post": {
"tags": [
"collections"
],
"summary": "Private Collection Publish",
"description": "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.",
"operationId": "private_collection_publish",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of collection",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/collections/{collection_id}/authors": {
"get": {
"tags": [
"collections"
],
"summary": "List collection authors",
"description": "List collection authors",
"operationId": "private_collection_authors_list",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Embargo for article",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Author"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Authors"
},
"put": {
"tags": [
"collections"
],
"summary": "Replace collection authors",
"description": "Associate new authors with the collection. This will remove all already associated authors and add these new ones",
"operationId": "private_collection_authors_replace",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "List of authors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorsCreator"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of list of authors",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Authors",
"x-codegen-request-body-name": "Authors"
},
"post": {
"tags": [
"collections"
],
"summary": "Add collection authors",
"description": "Associate new authors with the collection. This will add new authors to the list of already associated authors",
"operationId": "private_collection_authors_add",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "List of authors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorsCreator"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of list of authors",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Authors",
"x-codegen-request-body-name": "Authors"
}
},
"/account/collections/{collection_id}/authors/{author_id}": {
"delete": {
"tags": [
"collections"
],
"summary": "Delete collection author",
"description": "Delete collection author",
"operationId": "private_collection_author_delete",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "author_id",
"in": "path",
"description": "Collection Author unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Authors"
}
},
"/account/collections/{collection_id}/categories": {
"get": {
"tags": [
"collections"
],
"summary": "List collection categories",
"description": "List collection categories",
"operationId": "private_collection_categories_list",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Categories list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Category"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Categories"
},
"put": {
"tags": [
"collections"
],
"summary": "Replace collection categories",
"description": "Associate new categories with the collection. This will remove all already associated categories and add these new ones",
"operationId": "private_collection_categories_replace",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Categories list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoriesCreator"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of list of categories",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Categories",
"x-codegen-request-body-name": "categories"
},
"post": {
"tags": [
"collections"
],
"summary": "Add collection categories",
"description": "Associate new categories with the collection. This will add new categories to the list of already associated categories",
"operationId": "private_collection_categories_add",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Categories list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoriesCreator"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of list of categories",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Categories",
"x-codegen-request-body-name": "categories"
}
},
"/account/collections/{collection_id}/categories/{category_id}": {
"delete": {
"tags": [
"collections"
],
"summary": "Delete collection category",
"description": "De-associate category from collection",
"operationId": "private_collection_category_delete",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "category_id",
"in": "path",
"description": "Collection category unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Categories"
}
},
"/account/collections/{collection_id}/articles": {
"get": {
"tags": [
"collections"
],
"summary": "List collection articles",
"description": "List collection articles",
"operationId": "private_collection_articles_list",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Articles List",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Articles"
},
"put": {
"tags": [
"collections"
],
"summary": "Replace collection articles",
"description": "Associate new articles with the collection. This will remove all already associated articles and add these new ones",
"operationId": "private_collection_articles_replace",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Articles List",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticlesCreator"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of list of articles",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Articles",
"x-codegen-request-body-name": "articles"
},
"post": {
"tags": [
"collections"
],
"summary": "Add collection articles",
"description": "Associate new articles with the collection. This will add new articles to the list of already associated articles",
"operationId": "private_collection_articles_add",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Articles list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticlesCreator"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of new articles",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Articles",
"x-codegen-request-body-name": "articles"
}
},
"/account/collections/{collection_id}/articles/{article_id}": {
"delete": {
"tags": [
"collections"
],
"summary": "Delete collection article",
"description": "De-associate article from collection",
"operationId": "private_collection_article_delete",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "article_id",
"in": "path",
"description": "Collection article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Articles"
}
},
"/account/collections/{collection_id}/private_links": {
"get": {
"tags": [
"collections"
],
"summary": "List collection private links",
"description": "List article private links",
"operationId": "private_collection_private_links_list",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Collection private links",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Private Links"
},
"post": {
"tags": [
"collections"
],
"summary": "Create collection private link",
"description": "Create new private link",
"operationId": "private_collection_private_link_create",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionPrivateLinkCreator"
}
}
},
"required": false
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of private link",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateLinkResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Private Links",
"x-codegen-request-body-name": "private_link"
}
},
"/account/collections/{collection_id}/private_links/{link_id}": {
"get": {
"tags": [
"collections"
],
"summary": "View collection private link",
"description": "View existing private link for this collection",
"operationId": "private_collection_private_link_details",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "link_id",
"in": "path",
"description": "Private link token",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK. Collection private link",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateLink"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Private Links"
},
"put": {
"tags": [
"collections"
],
"summary": "Update collection private link",
"description": "Update existing private link for this collection",
"operationId": "private_collection_private_link_update",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "link_id",
"in": "path",
"description": "Private link token",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionPrivateLinkCreator"
}
}
},
"required": false
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of new private link",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"422": {
"description": "Unprocessable Entity",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Private Links",
"x-codegen-request-body-name": "private_link"
},
"delete": {
"tags": [
"collections"
],
"summary": "Disable private link",
"description": "Disable/delete private link for this collection",
"operationId": "private_collection_private_link_delete",
"parameters": [
{
"name": "collection_id",
"in": "path",
"description": "Collection unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "link_id",
"in": "path",
"description": "Private link token",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Collection Private Links"
}
},
"/institutions/{institution_string_id}/articles/filter-by": {
"get": {
"tags": [
"institutions"
],
"summary": "Public Institution Articles",
"description": "Returns a list of articles belonging to the institution",
"operationId": "institution_articles",
"parameters": [
{
"name": "institution_string_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resource_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filename",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK. An array of articles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
}
}
},
"/account/institution": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Account Institutions",
"description": "Account institution details",
"operationId": "private_institution_details",
"responses": {
"200": {
"description": "OK. An array of institutions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Institution"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/embargo_options": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Account Institution embargo options",
"description": "Account institution embargo options details",
"operationId": "private_institution_embargo_options_details",
"responses": {
"200": {
"description": "OK. An array of embargo options",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupEmbargoOptions"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/articles": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Institution Articles",
"description": "Get Articles from own institution. User must be administrator of the institution",
"operationId": "private_institution_articles",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
},
{
"name": "order",
"in": "query",
"description": "The field by which to order. Default varies by endpoint/resource.",
"schema": {
"type": "string",
"default": "published_date",
"enum": [
"published_date",
"modified_date"
]
}
},
{
"name": "order_direction",
"in": "query",
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "published_since",
"in": "query",
"description": "Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ",
"schema": {
"type": "string"
}
},
{
"name": "modified_since",
"in": "query",
"description": "Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "only return collections with this status",
"schema": {
"type": "integer"
}
},
{
"name": "resource_doi",
"in": "query",
"description": "only return collections with this resource_doi",
"schema": {
"type": "string"
}
},
{
"name": "item_type",
"in": "query",
"description": "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",
"schema": {
"type": "integer"
}
},
{
"name": "group",
"in": "query",
"description": "only return articles from this group",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of articles belonging to the institution",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/custom_fields": {
"get": {
"tags": [
"institutions"
],
"summary": "Private account institution group custom fields",
"description": "Returns the custom fields in the group the user belongs to, or the ones in the group specified, if the user has access.",
"operationId": "custom_fields_list",
"parameters": [
{
"name": "group_id",
"in": "query",
"description": "Group_id",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of custom fields",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShortCustomField"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/custom_fields/{custom_field_id}/items/upload": {
"post": {
"tags": [
"institutions"
],
"summary": "Custom fields values files upload",
"description": "Uploads a CSV containing values for a specific custom field of type dropdown_large_list. More details in the Custom Fields section",
"operationId": "custom_fields_upload",
"parameters": [
{
"name": "custom_field_id",
"in": "path",
"description": "Custom field identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"external_file": {
"type": "string",
"description": "CSV file to be uploaded",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"code": 200,
"message": "OK"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"409": {
"description": "Conflict",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/categories": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Account Categories",
"description": "List institution categories (including parent Categories)",
"operationId": "private_categories_list",
"responses": {
"200": {
"description": "OK. An array of categories",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryList"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/groups": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Account Institution Groups",
"description": "Returns the groups for which the account has administrative privileges (assigned and inherited).",
"operationId": "private_institution_groups_list",
"responses": {
"200": {
"description": "OK. An array of Groups",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/groups/{group_id}/embargo_options": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Account Institution Group Embargo Options",
"description": "Account institution group embargo options details",
"operationId": "private_group_embargo_options_details",
"parameters": [
{
"name": "group_id",
"in": "path",
"description": "Group identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of embargo options",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupEmbargoOptions"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/roles": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Account Institution Roles",
"description": "Returns the roles available for groups and the institution group.",
"operationId": "private_institution_roles_list",
"responses": {
"200": {
"description": "OK. An array of Roles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/accounts": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Account Institution Accounts",
"description": "Returns the accounts for which the account has administrative privileges (assigned and inherited).",
"operationId": "private_institution_accounts_list",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
},
{
"name": "is_active",
"in": "query",
"description": "Filter by active status",
"schema": {
"maximum": 1,
"minimum": 0,
"type": "integer"
}
},
{
"name": "institution_user_id",
"in": "query",
"description": "Filter by institution_user_id",
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "Filter by email",
"schema": {
"type": "string"
}
},
{
"name": "id_lte",
"in": "query",
"description": "Retrieve accounts with an ID lower or equal to the specified value",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"name": "id_gte",
"in": "query",
"description": "Retrieve accounts with an ID greater or equal to the specified value",
"schema": {
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of Accounts",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShortAccount"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
},
"post": {
"tags": [
"institutions"
],
"summary": "Create new Institution Account",
"description": "Create a new Account by sending account information. When the institution_user_id is provided, no verification email will be sent. The email_verified flag will automatically be set to true. If the institution_user_id is not provided, a verification email will be sent. The email_verified flag will be set to true once the account is created.",
"operationId": "private_institution_accounts_create",
"requestBody": {
"description": "Account description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCreateResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "Account"
}
},
"/account/institution/accounts/{account_id}": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Institution Account information",
"description": "Private Institution Account information",
"operationId": "private_institution_account",
"parameters": [
{
"name": "account_id",
"in": "path",
"description": "Account identifier the user is associated to",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Account"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
},
"put": {
"tags": [
"institutions"
],
"summary": "Update Institution Account",
"description": "Update Institution Account",
"operationId": "private_institution_accounts_update",
"parameters": [
{
"name": "account_id",
"in": "path",
"description": "Account identifier the user is associated to",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Account description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUpdate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of newly created article",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "Account"
}
},
"/account/institution/roles/{account_id}": {
"get": {
"tags": [
"institutions"
],
"summary": "List Institution Account Group Roles",
"description": "List Institution Account Group Roles",
"operationId": "private_institution_account_group_roles",
"parameters": [
{
"name": "account_id",
"in": "path",
"description": "Account identifier the user is associated to",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Account Group Roles",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupRoles"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
},
"post": {
"tags": [
"institutions"
],
"summary": "Add Institution Account Group Roles",
"description": "Add Institution Account Group Roles",
"operationId": "private_institution_account_group_roles_create",
"parameters": [
{
"name": "account_id",
"in": "path",
"description": "Account identifier the user is associated to",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Account description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupRolesCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "Account"
}
},
"/account/institution/roles/{account_id}/{group_id}/{role_id}": {
"delete": {
"tags": [
"institutions"
],
"summary": "Delete Institution Account Group Role",
"description": "Delete Institution Account Group Role",
"operationId": "private_institution_account_group_role_delete",
"parameters": [
{
"name": "account_id",
"in": "path",
"description": "Account identifier for which to remove the role",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "group_id",
"in": "path",
"description": "Group identifier for which to remove the role",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "role_id",
"in": "path",
"description": "Role identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/accounts/search": {
"post": {
"tags": [
"institutions"
],
"summary": "Private Account Institution Accounts Search",
"description": "Returns the accounts for which the account has administrative privileges (assigned and inherited).",
"operationId": "private_institution_accounts_search",
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstitutionAccountsSearch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK. An array of Accounts",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShortAccount"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "search"
}
},
"/account/institution/users/{account_id}": {
"get": {
"tags": [
"institutions"
],
"summary": "Private Account Institution User",
"description": "Retrieve institution user information using the account_id",
"operationId": "private_account_institution_user",
"parameters": [
{
"name": "account_id",
"in": "path",
"description": "Account identifier the user is associated to",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. User representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/reviews": {
"get": {
"tags": [
"institutions"
],
"summary": "Institution Curation Reviews",
"description": "Retrieve a list of curation reviews for this institution",
"operationId": "account_institution_curations",
"parameters": [
{
"name": "group_id",
"in": "query",
"description": "Filter by the group ID",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"name": "article_id",
"in": "query",
"description": "Retrieve the reviews for this article",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"description": "Filter by the status of the review",
"schema": {
"type": "string",
"enum": [
"pending",
"approved",
"rejected",
"closed"
]
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. A list of curation reviews.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Curation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/review/{curation_id}": {
"get": {
"tags": [
"institutions"
],
"summary": "Institution Curation Review",
"description": "Retrieve a certain curation review by its ID",
"operationId": "account_institution_curation",
"parameters": [
{
"name": "curation_id",
"in": "path",
"description": "ID of the curation",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. A curation review.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurationDetail"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/institution/review/{curation_id}/comments": {
"get": {
"tags": [
"institutions"
],
"summary": "Institution Curation Review Comments",
"description": "Retrieve a certain curation review's comments.",
"operationId": "get_account_institution_curation_comments",
"parameters": [
{
"name": "curation_id",
"in": "path",
"description": "ID of the curation",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. A curation review's comments.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurationComment"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
},
"post": {
"tags": [
"institutions"
],
"summary": "POST Institution Curation Review Comment",
"description": "Add a new comment to the review.",
"operationId": "post_account_institution_curation_comments",
"parameters": [
{
"name": "curation_id",
"in": "path",
"description": "ID of the curation",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "The content/value of the comment.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurationCommentCreate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "CurationComment"
}
},
"/institution/hrfeed/upload": {
"post": {
"tags": [
"institutions"
],
"summary": "Private Institution HRfeed Upload",
"description": "More info in the HR Feed section",
"operationId": "institution_hrfeed_upload",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"hrfeed": {
"type": "string",
"description": "You can find an example in the Hr Feed section",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseMessage"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/token": {
"get": {
"tags": [
"oauth"
],
"summary": "Get OAuth token information",
"description": "Returns information about the current OAuth token",
"operationId": "get_token_info",
"parameters": [
{
"name": "access_token",
"in": "query",
"description": "OAuth access token",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK. Token information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OAuthToken"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
}
},
"security": []
},
"post": {
"tags": [
"oauth"
],
"summary": "Create OAuth token",
"description": "Creates OAuth token using various grant types",
"operationId": "create_token",
"requestBody": {
"description": "Create OAuth Token Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOAuthToken"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/CreateOAuthToken"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK. Token created successfully RFC 6749 Section 5.1.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OAuthToken"
}
}
}
},
"400": {
"description": "Bad Request RFC 6749 Section 5.2.",
"content": {}
}
},
"security": [],
"x-codegen-request-body-name": "body"
}
},
"/item_types": {
"get": {
"tags": [
"other"
],
"summary": "Item Types",
"description": "Returns the list of Item Types of the requested group. If no user is authenticated, returns the item types available for Figshare.",
"operationId": "item_types_list",
"parameters": [
{
"name": "group_id",
"in": "query",
"description": "Identifier of the group for which the item types are requested",
"schema": {
"minimum": 0,
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "OK. An array of item types",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemType"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/funding/search": {
"post": {
"tags": [
"other"
],
"summary": "Search Funding",
"description": "Search for fundings",
"operationId": "private_funding_search",
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingSearch"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK. An array of funding information",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingInformation"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "search"
}
},
"/account": {
"get": {
"tags": [
"other"
],
"summary": "Private Account information",
"description": "Account information for token/personal token",
"operationId": "private_account",
"responses": {
"200": {
"description": "OK. Account representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Account"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/categories": {
"get": {
"tags": [
"other"
],
"summary": "Public Categories",
"description": "Returns a list of public categories",
"operationId": "categories_list",
"responses": {
"200": {
"description": "OK. An array of categories",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryList"
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/licenses": {
"get": {
"tags": [
"other"
],
"summary": "Public Licenses",
"description": "Returns a list of public licenses",
"operationId": "licenses_list",
"responses": {
"200": {
"description": "OK. An array of licenses",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/License"
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/account/licenses": {
"get": {
"tags": [
"other"
],
"summary": "Private Account Licenses",
"description": "This is a private endpoint that requires OAuth. It will return a list with figshare public licenses AND licenses defined for account's institution.",
"operationId": "private_licenses_list",
"responses": {
"200": {
"description": "OK. An array of personal licenses",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/License"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/file/download/{file_id}": {
"get": {
"tags": [
"other"
],
"summary": "Public File Download",
"description": "Starts the download of a file",
"operationId": "file_download",
"parameters": [
{
"name": "file_id",
"in": "path",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/account/profile": {
"put": {
"tags": [
"profiles"
],
"summary": "Update public profile",
"description": "Updates the fields of the user's public profile.",
"operationId": "update_user_profile",
"parameters": [
{
"name": "user_id",
"in": "query",
"description": "User ID",
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "institution_user_id",
"in": "query",
"description": "Institutional user ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileUpdateData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"code": 200,
"message": "OK"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-codegen-request-body-name": "User profile data"
}
},
"/account/profile/{user_id}/picture": {
"post": {
"tags": [
"profiles"
],
"summary": "Update public profile picture",
"description": "Updates the profile picture of the user's public profile.",
"operationId": "update_user_profile_picture",
"parameters": [
{
"name": "user_id",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"profile_picture"
],
"type": "object",
"properties": {
"profile_picture": {
"type": "string",
"description": "User profile picture",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"code": 200,
"message": "OK"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/projects": {
"get": {
"tags": [
"projects"
],
"summary": "Public Projects",
"description": "Returns a list of public projects",
"operationId": "projects_list",
"parameters": [
{
"name": "X-Cursor",
"in": "header",
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
},
{
"name": "order",
"in": "query",
"description": "The field by which to order. Default varies by endpoint/resource.",
"schema": {
"type": "string",
"default": "published_date",
"enum": [
"published_date",
"modified_date",
"views"
]
}
},
{
"name": "order_direction",
"in": "query",
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "institution",
"in": "query",
"description": "only return collections from this institution",
"schema": {
"type": "integer"
}
},
{
"name": "published_since",
"in": "query",
"description": "Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD",
"schema": {
"type": "string"
}
},
{
"name": "group",
"in": "query",
"description": "only return collections from this group",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. An array of projects",
"headers": {
"X-Cursor": {
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"422": {
"description": "Bad Request",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/projects/search": {
"post": {
"tags": [
"projects"
],
"summary": "Public Projects Search",
"description": "Returns a list of public articles",
"operationId": "projects_search",
"parameters": [
{
"name": "X-Cursor",
"in": "header",
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectsSearch"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK. An array of projects",
"headers": {
"X-Cursor": {
"description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"422": {
"description": "Bad Request",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-codegen-request-body-name": "search"
}
},
"/projects/{project_id}": {
"get": {
"tags": [
"projects"
],
"summary": "Public Project",
"description": "View a project",
"operationId": "project_details",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Project representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectComplete"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/projects/{project_id}/articles": {
"get": {
"tags": [
"projects"
],
"summary": "Public Project Articles",
"description": "List articles in project",
"operationId": "project_articles",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project Unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Project articles list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": []
}
},
"/account/projects/search": {
"post": {
"tags": [
"projects"
],
"summary": "Private Projects search",
"description": "Search inside the private projects",
"operationId": "private_projects_search",
"requestBody": {
"description": "Search Parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectsSearch"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK. An array of projects",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectPrivate"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"422": {
"description": "Bad Request",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [],
"x-codegen-request-body-name": "search"
}
},
"/account/projects": {
"get": {
"tags": [
"projects"
],
"summary": "Private Projects",
"description": "List private projects",
"operationId": "private_projects_list",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
},
{
"name": "order",
"in": "query",
"description": "The field by which to order.",
"schema": {
"type": "string",
"default": "published_date",
"enum": [
"published_date",
"modified_date",
"views"
]
}
},
{
"name": "order_direction",
"in": "query",
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "storage",
"in": "query",
"description": "only return collections from this institution",
"schema": {
"type": "string",
"enum": [
"group",
"individual"
]
}
},
{
"name": "roles",
"in": "query",
"description": "Any combination of owner, collaborator, viewer separated by comma. Examples: \"owner\" or \"owner,collaborator\".",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK. An array of projects",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectPrivate"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
},
"post": {
"tags": [
"projects"
],
"summary": "Create project",
"description": "Create a new project",
"operationId": "private_project_create",
"requestBody": {
"description": "Project description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project",
"x-codegen-request-body-name": "Project"
}
},
"/account/projects/{project_id}": {
"get": {
"tags": [
"projects"
],
"summary": "View project details",
"description": "View a private project",
"operationId": "private_project_details",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Project representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectCompletePrivate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project"
},
"put": {
"tags": [
"projects"
],
"summary": "Update project",
"description": "Updating an project by passing body parameters.",
"operationId": "private_project_update",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Project description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectUpdate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of project",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project",
"x-codegen-request-body-name": "Project"
},
"delete": {
"tags": [
"projects"
],
"summary": "Delete project",
"description": "A project can be deleted only if: - it is not public - it does not have public articles.\n\nWhen an individual project is deleted, all the articles are moved to my data of each owner.\n\nWhen 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.\n",
"operationId": "private_project_delete",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project"
},
"patch": {
"tags": [
"projects"
],
"summary": "Partially update project",
"description": "Partially update a project; only provided fields will be changed.",
"operationId": "private_project_partial_update",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Fields to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectUpdate"
}
}
},
"required": false
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location of project",
"schema": {
"type": "string",
"format": "link"
}
}
},
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project",
"x-codegen-request-body-name": "Project"
}
},
"/account/projects/{project_id}/publish": {
"post": {
"tags": [
"projects"
],
"summary": "Private Project Publish",
"description": "Publish a project. Possible after all items inside it are public",
"operationId": "private_project_publish",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseMessage"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
]
}
},
"/account/projects/{project_id}/notes": {
"get": {
"tags": [
"projects"
],
"summary": "List project notes",
"description": "List project notes",
"operationId": "private_project_notes_list",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number. Used for pagination with page_size",
"schema": {
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "page_size",
"in": "query",
"description": "The number of results included on a page. Used for pagination with page",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"default": 10
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results included on a page. Used for pagination with query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"schema": {
"maximum": 5000,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. List of project notes",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectNote"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Notes"
},
"post": {
"tags": [
"projects"
],
"summary": "Create project note",
"description": "Create a new project note",
"operationId": "private_project_notes_create",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Note message",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectNoteCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location note",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Notes",
"x-codegen-request-body-name": "Note"
}
},
"/account/projects/{project_id}/notes/{note_id}": {
"get": {
"tags": [
"projects"
],
"summary": "Project note details",
"operationId": "private_project_note",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "note_id",
"in": "path",
"description": "Note unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Note representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectNotePrivate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Notes"
},
"put": {
"tags": [
"projects"
],
"summary": "Update project note",
"operationId": "private_project_note_update",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "note_id",
"in": "path",
"description": "Note unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Note message",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectNoteCreate"
}
}
},
"required": true
},
"responses": {
"205": {
"description": "Reset Content",
"headers": {
"Location": {
"description": "Location note",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Notes",
"x-codegen-request-body-name": "Note"
},
"delete": {
"tags": [
"projects"
],
"summary": "Delete project note",
"operationId": "private_project_note_delete",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "note_id",
"in": "path",
"description": "Note unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Notes"
}
},
"/account/projects/{project_id}/leave": {
"post": {
"tags": [
"projects"
],
"summary": "Private Project Leave",
"description": "Please note: project's owner cannot leave the project.",
"operationId": "private_project_leave",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Collaborators"
}
},
"/account/projects/{project_id}/collaborators": {
"get": {
"tags": [
"projects"
],
"summary": "List project collaborators",
"description": "List Project collaborators and invited users",
"operationId": "private_project_collaborators_list",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. List of Collaborators",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCollaborator"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Collaborators"
},
"post": {
"tags": [
"projects"
],
"summary": "Invite project collaborators",
"description": "Invite users to collaborate on project or view the project",
"operationId": "private_project_collaborators_invite",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "viewer or collaborator role. User user_id or email of user",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectCollaboratorInvite"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseMessage"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Collaborators",
"x-codegen-request-body-name": "Collaborator"
}
},
"/account/projects/{project_id}/collaborators/{user_id}": {
"delete": {
"tags": [
"projects"
],
"summary": "Remove project collaborator",
"description": "Remove project collaborator",
"operationId": "private_project_collaborator__Delete",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "user_id",
"in": "path",
"description": "User unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Collaborators"
}
},
"/account/projects/{project_id}/articles": {
"get": {
"tags": [
"projects"
],
"summary": "List project articles",
"description": "List project articles",
"operationId": "private_project_articles_list",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. List of articles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Articles"
},
"post": {
"tags": [
"projects"
],
"summary": "Create project article",
"description": "Create a new Article and associate it with this project",
"operationId": "private_project_articles_create",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"requestBody": {
"description": "Article description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleProjectCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of article",
"schema": {
"type": "string",
"format": "url"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Articles",
"x-codegen-request-body-name": "Article"
}
},
"/account/projects/{project_id}/articles/{article_id}": {
"get": {
"tags": [
"projects"
],
"summary": "Project article details",
"description": "Project article details",
"operationId": "private_project_article_details",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "article_id",
"in": "path",
"description": "Project Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Article representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleCompletePrivate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Articles"
},
"delete": {
"tags": [
"projects"
],
"summary": "Delete project article",
"description": "Delete project article",
"operationId": "private_project_article_delete",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "article_id",
"in": "path",
"description": "Project Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Articles"
}
},
"/account/projects/{project_id}/articles/{article_id}/files": {
"get": {
"tags": [
"projects"
],
"summary": "Project article list files",
"description": "List article files",
"operationId": "private_project_article_files",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "article_id",
"in": "path",
"description": "Project Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. List of files",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateFile"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Articles"
}
},
"/account/projects/{project_id}/articles/{article_id}/files/{file_id}": {
"get": {
"tags": [
"projects"
],
"summary": "Project article file details",
"description": "Project article file details",
"operationId": "private_project_article_file",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "article_id",
"in": "path",
"description": "Project Article unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"name": "file_id",
"in": "path",
"description": "File unique identifier",
"required": true,
"schema": {
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. File representation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateFile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [
{
"OAuth2": [
"all"
]
}
],
"x-subcategory": "Private Project Articles"
}
},
"/symplectic/articles": {
"get": {
"tags": [
"symplectic"
],
"summary": "Get changed articles for Symplectic Elements",
"description": "Returns a list of articles for Symplectic Elements integration to synchronize article data.",
"operationId": "symplectic_changed_articles",
"parameters": [
{
"name": "since",
"in": "query",
"description": "ISO 8601 datetime string indicating the start of the search window (format: YYYY-MM-DD HH:MM:SS)",
"required": true,
"schema": {
"type": "string"
},
"example": "2015-01-01 00:00:00"
},
{
"name": "offset",
"in": "query",
"description": "Number of results to skip for pagination",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of results to return",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 10
}
},
{
"name": "status",
"in": "query",
"description": "Filter by article status",
"required": false,
"schema": {
"type": "string",
"enum": [
"public",
"private",
"draft"
]
}
},
{
"name": "is_embargoed",
"in": "query",
"description": "Filter by embargo status. When true, only returns articles with EMBARGO_ARTICLE type",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "OK. Returns a list of symplectic articles",
"headers": {
"ETag": {
"description": "Hash of the returned articles for caching purposes",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"400": {
"description": "Bad Request - Missing or invalid parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"401": {
"description": "Unauthorized - Missing or invalid OAuth token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
}
},
"security": [
{
"OAuth2": []
}
]
}
},
"/symplectic/users/{user_id}": {
"get": {
"tags": [
"symplectic"
],
"summary": "Get institutional user ID for a user",
"description": "Returns the institution user ID for a given user within the authenticated account's institution.",
"operationId": "symplectic_user_id",
"parameters": [
{
"name": "user_id",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Returns the institutional user ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"institutionUserId": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Unauthorized - Missing or invalid OAuth token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found - User not found or user has no account in this institution",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
}
},
"security": [
{
"OAuth2": []
}
]
}
},
"/symplectic/articles/{article_id}": {
"get": {
"tags": [
"symplectic"
],
"summary": "Get article details for Symplectic Elements",
"description": "Returns detailed information about a specific article for Symplectic Elements integration, including full metadata and author account information.",
"operationId": "symplectic_article",
"parameters": [
{
"name": "article_id",
"in": "path",
"description": "Article ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK. Returns the article details with full metadata",
"headers": {
"ETag": {
"description": "Hash of the returned article for caching purposes",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized - Missing or invalid OAuth token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found - Article not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
}
},
"security": [
{
"OAuth2": []
}
]
}
},
"/symplectic/accounts/{external_user_id}/articles": {
"get": {
"tags": [
"symplectic"
],
"summary": "Get articles for a specific account",
"description": "Returns a list of articles for a specific user account identified by external_user_id (symplectic_user_id or institution_user_id).",
"operationId": "symplectic_account_articles",
"parameters": [
{
"name": "external_user_id",
"in": "path",
"description": "External user ID (symplectic_user_id or institution_user_id)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "Number of results to skip for pagination",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of results to return",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 10
}
},
{
"name": "status",
"in": "query",
"description": "Filter by article status",
"required": false,
"schema": {
"type": "string",
"enum": [
"public",
"private",
"draft"
]
}
},
{
"name": "is_embargoed",
"in": "query",
"description": "Filter by embargo status",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "OK. Returns a list of articles for the specified account",
"headers": {
"ETag": {
"description": "Hash of the returned articles for caching purposes",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"401": {
"description": "Unauthorized - Missing or invalid OAuth token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Not Found - Account not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
}
},
"security": [
{
"OAuth2": []
}
]
}
},
"/symplectic/accounts": {
"get": {
"tags": [
"symplectic"
],
"summary": "Get changed accounts for Symplectic Elements",
"description": "Returns a list of accounts that have been modified since the specified date for Symplectic Elements integration.",
"operationId": "symplectic_accounts_ids",
"parameters": [
{
"name": "since",
"in": "query",
"description": "ISO 8601 datetime string indicating the start of the search window (format: YYYY-MM-DD HH:MM:SS)",
"required": true,
"schema": {
"type": "string"
},
"example": "2015-01-01 00:00:00"
}
],
"responses": {
"200": {
"description": "OK. Returns a list of modified accounts",
"headers": {
"ETag": {
"description": "Hash of the returned accounts for caching purposes",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"institutionUserId": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
},
"400": {
"description": "Bad Request - Missing or invalid parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"401": {
"description": "Unauthorized - Missing or invalid OAuth token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
}
},
"security": [
{
"OAuth2": []
}
]
}
}
},
"components": {
"schemas": {
"Account": {
"required": [
"active",
"created_date",
"email",
"first_name",
"group_id",
"id",
"institution_id",
"institution_user_id",
"last_name",
"maximum_file_size",
"modified_date",
"orcid_id",
"pending_quota_request",
"quota",
"symplectic_user_id",
"used_quota",
"used_quota_private",
"used_quota_public",
"user_id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Account id",
"example": 1495682
},
"first_name": {
"type": "string",
"description": "First Name",
"example": "Doe"
},
"last_name": {
"type": "string",
"description": "Last Name",
"example": "John"
},
"used_quota_private": {
"type": "integer",
"description": "Account used private quota",
"example": 0
},
"modified_date": {
"type": "string",
"description": "Date of last account modification",
"example": "2018-05-22T04:04:04"
},
"used_quota": {
"type": "integer",
"description": "Account total used quota",
"example": 0
},
"created_date": {
"type": "string",
"description": "Date when account was created",
"example": "2018-05-22T04:04:04"
},
"quota": {
"type": "integer",
"description": "Account quota",
"example": 0
},
"group_id": {
"type": "integer",
"description": "Account group id",
"example": 0
},
"institution_user_id": {
"type": "string",
"description": "Account institution user id",
"example": "djohn42"
},
"institution_id": {
"type": "integer",
"description": "Account institution",
"example": 1
},
"email": {
"type": "string",
"description": "User email",
"example": "user@domain.com"
},
"used_quota_public": {
"type": "integer",
"description": "Account public used quota",
"example": 0
},
"pending_quota_request": {
"type": "boolean",
"description": "True if a quota request is pending",
"example": true
},
"active": {
"type": "integer",
"description": "Account activity status",
"example": 0
},
"maximum_file_size": {
"type": "integer",
"description": "Maximum upload size for account",
"example": 0
},
"user_id": {
"type": "integer",
"description": "User id associated with account, useful for example for adding the account as an author to an item",
"example": 1000001
},
"orcid_id": {
"type": "string",
"description": "ORCID iD associated to account",
"example": "0000-0001-2345-6789"
},
"symplectic_user_id": {
"type": "string",
"description": "Symplectic ID associated to account",
"example": "djohn42"
}
},
"x-tag": "other"
},
"AccountCreate": {
"required": [
"last_name",
"email"
],
"type": "object",
"properties": {
"email": {
"maxLength": 150,
"minLength": 3,
"type": "string",
"description": "Email of account",
"example": "johndoe@example.com"
},
"first_name": {
"maxLength": 255,
"type": "string",
"description": "First Name",
"example": "John",
"default": ""
},
"last_name": {
"maxLength": 255,
"type": "string",
"description": "Last Name",
"example": "Doe",
"default": ""
},
"group_id": {
"type": "integer",
"description": "Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups"
},
"institution_user_id": {
"maxLength": 50,
"type": "string",
"description": "Institution user id",
"example": "johndoe",
"default": ""
},
"symplectic_user_id": {
"maxLength": 50,
"type": "string",
"description": "Symplectic user id",
"example": "johndoe",
"default": ""
},
"quota": {
"type": "integer",
"description": "Account quota",
"example": 1000
},
"is_active": {
"type": "boolean",
"description": "Is account active"
}
},
"x-tag": "institutions",
"x-maxCombinedLength": {
"description": "The combined length of first_name and last_name must not exceed 255 characters."
}
},
"AccountCreateResponse": {
"required": [
"account_id"
],
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"description": "ID of created account",
"example": 33334444
}
},
"x-tag": "common"
},
"AccountGroupRoles": {
"type": "object",
"example": {
"2": [
{
"category": "group",
"id": 7,
"name": "User"
}
]
},
"x-tag": "institutions"
},
"AccountGroupRolesCreate": {
"type": "object",
"example": {
"2": [
2,
7
],
"3": [
7,
9
]
},
"x-tag": "institutions"
},
"AccountReport": {
"required": [
"account_id",
"created_date",
"download_url",
"group_id",
"id",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "A unique ID for the AccountRecord"
},
"account_id": {
"type": "integer",
"description": "The ID of the account which generated this report."
},
"created_date": {
"type": "string",
"description": "Date when the AccountReport was requested",
"example": "2017-05-15T15:12:26Z"
},
"status": {
"type": "string",
"description": "Status of the report",
"enum": [
"missing",
"pending",
"done"
]
},
"download_url": {
"type": "string",
"description": "The download link for the generated XLSX",
"format": "url",
"example": "https://some.com/storage/path/123/report-456.xlsx"
},
"group_id": {
"type": "integer",
"description": "The group ID that was used to filter the report, if any."
}
}
},
"AccountUpdate": {
"required": [
"is_active",
"group_id"
],
"type": "object",
"properties": {
"group_id": {
"type": "integer",
"description": "Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups"
},
"is_active": {
"type": "boolean",
"description": "Is account active"
}
},
"x-tag": "institutions"
},
"Article": {
"required": [
"created_date",
"defined_type",
"defined_type_name",
"doi",
"handle",
"id",
"resource_doi",
"resource_title",
"thumb",
"timeline",
"title",
"url",
"url_private_api",
"url_private_html",
"url_public_api",
"url_public_html"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for article",
"example": 1434614
},
"title": {
"type": "string",
"description": "Title of article",
"example": "Test article title"
},
"doi": {
"type": "string",
"description": "DOI",
"example": "10.6084/m9.figshare.1434614"
},
"handle": {
"type": "string",
"description": "Handle",
"example": "111184/figshare.1234"
},
"url": {
"type": "string",
"description": "Api endpoint for article",
"format": "url",
"example": "http://api.figshare.com/articles/1434614"
},
"url_public_html": {
"type": "string",
"description": "Public site endpoint for article",
"format": "url",
"example": "https://figshare.com/articles/media/Test_article_title/1434614"
},
"url_public_api": {
"type": "string",
"description": "Public Api endpoint for article",
"format": "url",
"example": "https://api.figshare.com/articles/1434614"
},
"url_private_html": {
"type": "string",
"description": "Private site endpoint for article",
"format": "url",
"example": "https://figshare.com/account/articles/1434614"
},
"url_private_api": {
"type": "string",
"description": "Private Api endpoint for article",
"format": "url",
"example": "https://api.figshare.com/account/articles/1434614"
},
"timeline": {
"$ref": "#/components/schemas/Timeline"
},
"thumb": {
"type": "string",
"description": "Thumbnail image",
"format": "url",
"example": "https://ndownloader.figshare.com/files/123456789/preview/12345678/thumb.png"
},
"defined_type": {
"type": "integer",
"description": "Type of article identifier",
"example": 3
},
"defined_type_name": {
"type": "string",
"description": "Name of the article type identifier",
"example": "media"
},
"resource_doi": {
"type": "string",
"description": "Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article DOI.",
"default": ""
},
"resource_title": {
"type": "string",
"description": "Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article title.",
"default": ""
},
"created_date": {
"type": "string",
"description": "Date when article was created",
"example": "2017-05-18T11:49:03Z"
}
},
"x-tag": "articles"
},
"ArticleComplete": {
"required": [
"authors",
"custom_fields",
"download_disabled",
"embargo_options",
"figshare_url",
"files",
"folder_structure"
],
"properties": {
"figshare_url": {
"type": "string",
"description": "Article public url",
"format": "url",
"example": "http://figshare.com/articles/media/article_name/2000005"
},
"download_disabled": {
"type": "boolean",
"description": "If true, downloading of files for this article is disabled",
"example": false
},
"files": {
"type": "array",
"description": "List of up to 10 article files.",
"items": {
"$ref": "#/components/schemas/PublicFile"
}
},
"folder_structure": {
"type": "object",
"properties": {},
"description": "Mapping of file ids to folder paths, if folders are used",
"example": {
"3000002": "Test Folder"
}
},
"authors": {
"type": "array",
"description": "List of article authors",
"items": {
"$ref": "#/components/schemas/Author"
}
},
"custom_fields": {
"type": "array",
"description": "List of custom fields values",
"items": {
"$ref": "#/components/schemas/CustomArticleField"
}
},
"embargo_options": {
"type": "array",
"description": "List of embargo options",
"items": {
"$ref": "#/components/schemas/GroupEmbargoOptions"
}
}
},
"allOf": [
{
"$ref": "#/components/schemas/ProjectArticle"
}
],
"x-tag": "articles"
},
"ArticleCompletePrivate": {
"required": [
"account_id",
"curation_status"
],
"properties": {
"account_id": {
"type": "integer",
"description": "ID of the account owning the article",
"example": 1000001
},
"curation_status": {
"type": "string",
"description": "Curation status of the article",
"example": "approved"
}
},
"allOf": [
{
"$ref": "#/components/schemas/ArticleComplete"
}
],
"x-tag": "articles"
},
"ArticleConfidentiality": {
"required": [
"is_confidential",
"reason"
],
"type": "object",
"properties": {
"is_confidential": {
"type": "boolean",
"description": "True if article is confidential",
"example": true
},
"reason": {
"type": "string",
"description": "Reason for confidentiality",
"example": "need to"
}
},
"x-tag": "articles"
},
"ArticleCreate": {
"required": [
"title"
],
"type": "object",
"properties": {
"title": {
"maxLength": 1000,
"minLength": 3,
"type": "string",
"description": "Title of article",
"example": "Test article title"
},
"description": {
"maxLength": 20000,
"type": "string",
"description": "The article description. In a publisher case, usually this is the remote article description",
"example": "Test description of article",
"default": ""
},
"is_metadata_record": {
"type": "boolean",
"description": "True if article has no files",
"example": true
},
"metadata_reason": {
"type": "string",
"description": "Article metadata reason",
"example": "hosted somewhere else"
},
"tags": {
"type": "array",
"description": "List of tags to be associated with the article. Keywords can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"description": "List of tags to be associated with the article. Tags can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"description": "List of links to be associated with the article (e.g [\"http://link1\", \"http://link2\", \"http://link3\"])",
"example": [
"http://figshare.com",
"http://api.figshare.com"
],
"items": {
"type": "string",
"format": "link"
}
},
"related_materials": {
"type": "array",
"description": "List of related materials; supersedes references and resource DOI/title.",
"example": [
{
"id": 10432,
"identifier": "10.6084/m9.figshare.1407024",
"identifier_type": "DOI",
"relation": "IsSupplementTo",
"title": "Figshare for institutions brochure",
"is_linkout": false
}
],
"items": {
"$ref": "#/components/schemas/RelatedMaterial"
}
},
"categories": {
"type": "array",
"description": "List of category ids to be associated with the article(e.g [1, 23, 33, 66])",
"example": [
1,
10,
11
],
"items": {
"type": "integer"
}
},
"categories_by_source_id": {
"type": "array",
"description": "List of category source ids to be associated with the article, supersedes the categories property",
"example": [
"300204",
"400207"
],
"items": {
"type": "string"
}
},
"authors": {
"type": "array",
"description": "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.",
"example": [
{
"name": "John Doe"
},
{
"id": 1000008
}
],
"items": {
"type": "object",
"properties": {}
}
},
"custom_fields": {
"type": "object",
"properties": {},
"description": "List of key, values pairs to be associated with the article",
"example": {
"defined_key": "value for it"
}
},
"custom_fields_list": {
"type": "array",
"description": "List of custom fields values, supersedes custom_fields parameter",
"items": {
"$ref": "#/components/schemas/CustomArticleFieldAdd"
}
},
"defined_type": {
"type": "string",
"description": "One of: figure online resource preprint book conference contribution media dataset poster journal contribution presentation thesis software",
"example": "media"
},
"funding": {
"type": "string",
"description": "Grant number or funding authority",
"default": ""
},
"funding_list": {
"type": "array",
"description": "Funding creation / update items",
"items": {
"$ref": "#/components/schemas/FundingCreate"
}
},
"license": {
"type": "integer",
"description": "License id for this article.",
"example": 1,
"default": 0
},
"doi": {
"type": "string",
"description": "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.",
"default": ""
},
"handle": {
"type": "string",
"description": "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.",
"default": ""
},
"resource_doi": {
"type": "string",
"description": "Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article DOI.",
"default": ""
},
"resource_title": {
"type": "string",
"description": "Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article title.",
"default": ""
},
"timeline": {
"$ref": "#/components/schemas/TimelineUpdate"
},
"group_id": {
"type": "integer",
"description": "Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups"
}
},
"x-tag": "articles"
},
"ArticleDOI": {
"required": [
"doi"
],
"type": "object",
"properties": {
"doi": {
"type": "string",
"description": "Reserved DOI",
"example": "10.5072/FK2.FIGSHARE.20345"
}
},
"x-tag": "articles"
},
"ArticleEmbargo": {
"required": [
"embargo_options",
"embargo_reason",
"embargo_title",
"is_embargoed"
],
"type": "object",
"properties": {
"is_embargoed": {
"type": "boolean",
"description": "True if embargoed",
"example": true
},
"embargo_title": {
"type": "string",
"description": "Title for embargo",
"example": "File(s) under embargo"
},
"embargo_reason": {
"type": "string",
"description": "Reason for embargo",
"example": ""
},
"embargo_options": {
"type": "array",
"description": "List of embargo permissions that are associated with the article. If the type is logged_in and the group_ids list is empty, then the whole institution can see the article; if there are multiple group_ids, then only users that are under those groups can see the article.",
"example": [
{
"id": 13,
"type": "ip_range",
"group_ids": [],
"ip_name": "bacau"
},
{
"id": 12,
"type": "logged_in",
"ip_name": "",
"group_ids": [
550,
9448
]
}
],
"items": {
"type": "object",
"properties": {}
}
}
},
"x-tag": "articles"
},
"ArticleEmbargoUpdater": {
"required": [
"embargo_date",
"embargo_type",
"is_embargoed"
],
"type": "object",
"properties": {
"is_embargoed": {
"type": "boolean",
"description": "Embargo status",
"example": true
},
"embargo_date": {
"type": "string",
"description": "Date when the embargo expires and the article gets published, '0' value will set up permanent embargo",
"example": "2018-05-22T04:04:04"
},
"embargo_type": {
"type": "string",
"description": "Embargo can be enabled at the article or the file level. Possible values: article, file",
"example": "file",
"enum": [
"article",
"file"
]
},
"embargo_title": {
"type": "string",
"description": "Title for embargo",
"example": "File(s) under embargo"
},
"embargo_reason": {
"type": "string",
"description": "Reason for setting embargo",
"example": ""
},
"embargo_options": {
"type": "array",
"description": "List of embargo permissions to be associated with the article. The list must contain `id` and can also contain `group_ids`(a field that only applies to 'logged_in' permissions). The new list replaces old options in the database, and an empty list removes all permissions for this article. Administration permission has to be set up alone but logged in and IP range permissions can be set up together.",
"example": [
{
"id": 1321
},
{
"id": 3345
},
{
"id": 54621,
"group_ids": [
4332,
5433,
678
]
}
],
"items": {
"type": "object",
"properties": {}
}
}
},
"x-tag": "articles"
},
"ArticleHandle": {
"required": [
"handle"
],
"type": "object",
"properties": {
"handle": {
"type": "string",
"description": "Reserved Handle",
"example": "11172/FK2.FIGSHARE.20345"
}
},
"x-tag": "articles"
},
"ArticleProjectCreate": {
"required": [
"title"
],
"type": "object",
"properties": {
"title": {
"maxLength": 1000,
"minLength": 3,
"type": "string",
"description": "Title of article",
"example": "Test article title"
},
"description": {
"maxLength": 20000,
"type": "string",
"description": "The article description. In a publisher case, usually this is the remote article description",
"example": "Test description of article",
"default": ""
},
"tags": {
"type": "array",
"description": "List of tags to be associated with the article. Keywords can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"description": "List of tags to be associated with the article. Tags can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"description": "List of links to be associated with the article (e.g [\"http://link1\", \"http://link2\", \"http://link3\"])",
"example": [
"http://figshare.com",
"http://api.figshare.com"
],
"items": {
"type": "string",
"format": "link"
}
},
"related_materials": {
"type": "array",
"description": "List of related materials; supersedes references and resource DOI/title.",
"example": [
{
"id": 10432,
"identifier": "10.6084/m9.figshare.1407024",
"identifier_type": "DOI",
"relation": "IsSupplementTo",
"title": "Figshare for institutions brochure",
"is_linkout": false
}
],
"items": {
"$ref": "#/components/schemas/RelatedMaterial"
}
},
"categories": {
"type": "array",
"description": "List of category ids to be associated with the article(e.g [1, 23, 33, 66])",
"example": [
1,
10,
11
],
"items": {
"type": "integer"
}
},
"categories_by_source_id": {
"type": "array",
"description": "List of category source ids to be associated with the article, supersedes the categories property",
"example": [
"300204",
"400207"
],
"items": {
"type": "string"
}
},
"authors": {
"type": "array",
"description": "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.",
"example": [
{
"name": "John Doe"
},
{
"id": 1000008
}
],
"items": {
"type": "object",
"properties": {}
}
},
"custom_fields": {
"type": "object",
"properties": {},
"description": "List of key, values pairs to be associated with the article",
"example": {
"defined_key": "value for it"
}
},
"custom_fields_list": {
"type": "array",
"description": "List of custom fields values, supersedes custom_fields parameter",
"items": {
"$ref": "#/components/schemas/CustomArticleFieldAdd"
}
},
"defined_type": {
"type": "string",
"description": "One of: figure online resource preprint book conference contribution media dataset poster journal contribution presentation thesis software",
"example": "media"
},
"funding": {
"type": "string",
"description": "Grant number or funding authority",
"default": ""
},
"funding_list": {
"type": "array",
"description": "Funding creation / update items",
"items": {
"$ref": "#/components/schemas/FundingCreate"
}
},
"license": {
"type": "integer",
"description": "License id for this article.",
"example": 1,
"default": 0
},
"doi": {
"type": "string",
"description": "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.",
"default": ""
},
"handle": {
"type": "string",
"description": "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.",
"default": ""
},
"resource_doi": {
"type": "string",
"description": "Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article DOI.",
"default": ""
},
"resource_title": {
"type": "string",
"description": "Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article title.",
"default": ""
},
"timeline": {
"$ref": "#/components/schemas/TimelineUpdate"
}
},
"x-tag": "articles"
},
"ArticleSearch": {
"properties": {
"resource_doi": {
"type": "string",
"description": "Only return articles with this resource_doi",
"example": "10.6084/m9.figshare.1407024"
},
"item_type": {
"type": "integer",
"description": "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",
"example": 1
},
"doi": {
"type": "string",
"description": "Only return articles with this doi",
"example": "10.6084/m9.figshare.1407024"
},
"handle": {
"type": "string",
"description": "Only return articles with this handle",
"example": "111084/m9.figshare.14074"
},
"project_id": {
"type": "integer",
"description": "Only return articles in this project",
"example": 1
},
"order": {
"type": "string",
"description": "The field by which to order",
"example": "published_date",
"default": "created_date",
"enum": [
"created_date",
"published_date",
"modified_date",
"views",
"shares",
"downloads",
"cites"
]
}
},
"allOf": [
{
"$ref": "#/components/schemas/CommonSearch"
}
],
"x-tag": "articles"
},
"ArticleUnpublishData": {
"required": [
"reason"
],
"type": "object",
"properties": {
"reason": {
"maxLength": 500,
"minLength": 5,
"type": "string",
"description": "Reason of article unpublishing",
"example": "Unpublish article reason"
}
},
"x-tag": "articles"
},
"ArticleUpdate": {
"type": "object",
"properties": {
"title": {
"maxLength": 1000,
"minLength": 3,
"type": "string",
"description": "Title of article",
"example": "Test article title"
},
"description": {
"maxLength": 20000,
"type": "string",
"description": "The article description. In a publisher case, usually this is the remote article description",
"example": "Test description of article",
"default": ""
},
"is_metadata_record": {
"type": "boolean",
"description": "True if article has no files",
"example": true
},
"metadata_reason": {
"type": "string",
"description": "Article metadata reason",
"example": "hosted somewhere else"
},
"tags": {
"type": "array",
"description": "List of tags to be associated with the article. Keywords can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"description": "List of tags to be associated with the article. Tags can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"description": "List of links to be associated with the article (e.g [\"http://link1\", \"http://link2\", \"http://link3\"])",
"example": [
"http://figshare.com",
"http://api.figshare.com"
],
"items": {
"type": "string",
"format": "link"
}
},
"related_materials": {
"type": "array",
"description": "List of related materials; supersedes references and resource DOI/title.",
"example": [
{
"id": 10432,
"identifier": "10.6084/m9.figshare.1407024",
"identifier_type": "DOI",
"relation": "IsSupplementTo",
"title": "Figshare for institutions brochure",
"is_linkout": false
}
],
"items": {
"$ref": "#/components/schemas/RelatedMaterial"
}
},
"categories": {
"type": "array",
"description": "List of category ids to be associated with the article(e.g [1, 23, 33, 66])",
"example": [
1,
10,
11
],
"items": {
"type": "integer"
}
},
"categories_by_source_id": {
"type": "array",
"description": "List of category source ids to be associated with the article, supersedes the categories property",
"example": [
"300204",
"400207"
],
"items": {
"type": "string"
}
},
"authors": {
"type": "array",
"description": "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.",
"example": [
{
"name": "John Doe"
},
{
"id": 1000008
}
],
"items": {
"type": "object",
"properties": {}
}
},
"custom_fields": {
"type": "object",
"properties": {},
"description": "List of key, values pairs to be associated with the article",
"example": {
"defined_key": "value for it"
}
},
"custom_fields_list": {
"type": "array",
"description": "List of custom fields values, supersedes custom_fields parameter",
"items": {
"$ref": "#/components/schemas/CustomArticleFieldAdd"
}
},
"defined_type": {
"type": "string",
"description": "One of: figure online resource preprint book conference contribution media dataset poster journal contribution presentation thesis software",
"example": "media"
},
"funding": {
"type": "string",
"description": "Grant number or funding authority",
"default": ""
},
"funding_list": {
"type": "array",
"description": "Funding creation / update items",
"items": {
"$ref": "#/components/schemas/FundingCreate"
}
},
"license": {
"type": "integer",
"description": "License id for this article.",
"example": 1,
"default": 0
},
"doi": {
"type": "string",
"description": "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.",
"default": ""
},
"handle": {
"type": "string",
"description": "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.",
"default": ""
},
"resource_doi": {
"type": "string",
"description": "Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article DOI.",
"default": ""
},
"resource_title": {
"type": "string",
"description": "Deprecated by related materials. Not applicable to regular users. In a publisher case, this is the publisher article title.",
"default": ""
},
"timeline": {
"$ref": "#/components/schemas/TimelineUpdate"
},
"download_disabled": {
"type": "boolean",
"description": "If true, downloading of files for this article is disabled",
"example": false
},
"group_id": {
"type": "integer",
"description": "Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups"
}
},
"x-tag": "articles"
},
"ArticleVersionUpdate": {
"type": "object",
"properties": {
"supplementary_fields": {
"type": "array",
"description": "List of supplementary fields to be associated with the article version",
"example": [
{
"name": "abc",
"value": "def"
},
{
"name": "fname",
"value": "fvalue"
}
],
"items": {
"type": "object",
"properties": {}
}
},
"internal_metadata": {
"type": "object",
"properties": {},
"description": "List of supplementary fields to be associated with the article version",
"example": {
"curation_review_date": "2021-11-16T13:03:38",
"export_pdf_download_url": null
}
}
},
"x-tag": "article_version"
},
"ArticleVersions": {
"required": [
"url",
"version"
],
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Version number",
"example": 1
},
"url": {
"type": "string",
"description": "Api endpoint for the item version",
"format": "url",
"example": "https://api.figshare.com/v2/articles/2000005/versions/1"
}
},
"x-tag": "articles"
},
"ArticleWithProject": {
"required": [
"project_id"
],
"properties": {
"project_id": {
"type": "integer",
"description": "Project id for this article.",
"example": 1,
"default": 0
}
},
"allOf": [
{
"$ref": "#/components/schemas/Article"
}
],
"x-tag": "articles_with_project"
},
"ArticlesCreator": {
"required": [
"articles"
],
"type": "object",
"properties": {
"articles": {
"type": "array",
"description": "List of article ids",
"example": [
2000003,
2000004
],
"items": {
"type": "integer",
"description": "Id of article"
}
}
},
"x-tag": "articles"
},
"Author": {
"required": [
"first_name",
"full_name",
"id",
"is_active",
"last_name",
"orcid_id",
"url_name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Author id",
"example": 97657
},
"full_name": {
"type": "string",
"description": "Author full name",
"example": "John Doe"
},
"first_name": {
"type": "string",
"description": "Author first name",
"example": "John"
},
"last_name": {
"type": "string",
"description": "Author last name",
"example": "Doe"
},
"is_active": {
"type": "boolean",
"description": "True if author has published items",
"example": false
},
"url_name": {
"type": "string",
"description": "Author url name",
"example": "John_Doe"
},
"orcid_id": {
"type": "string",
"description": "Author Orcid",
"example": "1234-5678-9123-1234"
}
},
"x-tag": "authors"
},
"AuthorComplete": {
"required": [
"first_name",
"group_id",
"institution_id",
"is_public",
"job_title",
"last_name"
],
"properties": {
"institution_id": {
"type": "integer",
"description": "Institution id"
},
"group_id": {
"type": "integer",
"description": "Group id"
},
"first_name": {
"type": "string",
"description": "First Name"
},
"last_name": {
"type": "string",
"description": "Last Name"
},
"is_public": {
"type": "integer",
"description": "if 1 then the author has published items"
},
"job_title": {
"type": "string",
"description": "Job title"
}
},
"allOf": [
{
"$ref": "#/components/schemas/Author"
}
],
"x-tag": "authors"
},
"AuthorsCreator": {
"required": [
"authors"
],
"type": "object",
"properties": {
"authors": {
"type": "array",
"description": "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.",
"example": [
{
"id": 12121
},
{
"id": 34345
},
{
"name": "John Doe"
}
],
"items": {
"type": "object",
"properties": {}
}
}
},
"x-tag": "articles"
},
"CategoriesCreator": {
"required": [
"categories"
],
"type": "object",
"properties": {
"categories": {
"type": "array",
"description": "List of category ids",
"example": [
1,
10,
11
],
"items": {
"type": "integer",
"description": "Id of category"
}
}
},
"x-tag": "articles"
},
"Category": {
"required": [
"id",
"parent_id",
"path",
"source_id",
"taxonomy_id",
"title"
],
"type": "object",
"properties": {
"parent_id": {
"type": "integer",
"description": "Parent category",
"example": 1
},
"id": {
"type": "integer",
"description": "Category id",
"example": 11
},
"title": {
"type": "string",
"description": "Category title",
"example": "Anatomy"
},
"path": {
"type": "string",
"description": "Path to all ancestor ids",
"example": "/450/1024/6532"
},
"source_id": {
"type": "string",
"description": "ID in original standard taxonomy",
"example": "300204"
},
"taxonomy_id": {
"type": "integer",
"description": "Internal id of taxonomy the category is part of",
"example": 4
}
},
"x-tag": "common"
},
"CategoryList": {
"required": [
"has_children",
"is_selectable"
],
"properties": {
"is_selectable": {
"type": "boolean",
"description": "The selectable status",
"example": true
},
"has_children": {
"type": "boolean",
"description": "True if category has children",
"example": false
}
},
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"x-tag": "common"
},
"Collaborator": {
"required": [
"name",
"role_name",
"user_id"
],
"type": "object",
"properties": {
"role_name": {
"type": "string",
"description": "Collaborator role",
"example": "Owner"
},
"user_id": {
"type": "integer",
"description": "Collaborator id",
"example": 1
},
"name": {
"type": "string",
"description": "Collaborator name",
"example": "name"
}
},
"x-tag": "projects"
},
"Collection": {
"required": [
"doi",
"handle",
"id",
"timeline",
"title",
"url"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Collection id",
"example": 123
},
"title": {
"type": "string",
"description": "Collection title",
"example": "Sample collection"
},
"doi": {
"type": "string",
"description": "Collection DOI",
"example": "10.6084/m9.figshare.123"
},
"handle": {
"type": "string",
"description": "Collection Handle",
"example": "111184/figshare.1234"
},
"url": {
"type": "string",
"description": "Api endpoint",
"example": "https://api.figshare.com/v2/collections/123"
},
"timeline": {
"$ref": "#/components/schemas/Timeline"
}
},
"x-tag": "collections"
},
"CollectionComplete": {
"required": [
"articles_count",
"authors",
"categories",
"citation",
"created_date",
"custom_fields",
"description",
"funding",
"group_id",
"institution_id",
"keywords",
"modified_date",
"public",
"references",
"related_materials",
"resource_doi",
"resource_id",
"resource_link",
"resource_title",
"resource_version",
"tags",
"timeline",
"version"
],
"properties": {
"funding": {
"type": "array",
"description": "Full Collection funding information",
"items": {
"$ref": "#/components/schemas/FundingInformation"
}
},
"resource_id": {
"type": "string",
"description": "Collection resource id",
"example": ""
},
"resource_doi": {
"type": "string",
"description": "Collection resource doi",
"example": "10.6084/m9.figshare.123"
},
"resource_title": {
"type": "string",
"description": "Collection resource title",
"example": "test"
},
"resource_link": {
"type": "string",
"description": "Collection resource link",
"example": "http://figshare.com"
},
"resource_version": {
"type": "integer",
"description": "Collection resource version",
"example": 0
},
"version": {
"type": "integer",
"description": "Collection version",
"example": 1
},
"description": {
"type": "string",
"description": "Collection description",
"example": "description"
},
"categories": {
"type": "array",
"description": "List of collection categories",
"items": {
"$ref": "#/components/schemas/Category"
}
},
"references": {
"type": "array",
"description": "List of collection references",
"items": {
"type": "string",
"format": "url"
}
},
"related_materials": {
"type": "array",
"description": "List of related materials; supersedes references and resource DOI/title.",
"example": [
{
"id": 10432,
"identifier": "10.6084/m9.figshare.1407024",
"identifier_type": "DOI",
"relation": "IsSupplementTo",
"title": "Figshare for institutions brochure",
"is_linkout": false
}
],
"items": {
"$ref": "#/components/schemas/RelatedMaterial"
}
},
"tags": {
"type": "array",
"description": "List of collection tags. Keywords can be used instead",
"example": [
"t1",
"t2"
],
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"description": "List of collection keywords. Tags can be used instead",
"example": [
"t1",
"t2"
],
"items": {
"type": "string"
}
},
"authors": {
"type": "array",
"description": "List of collection authors",
"items": {
"$ref": "#/components/schemas/Author"
}
},
"institution_id": {
"type": "integer",
"description": "Collection institution",
"example": 1
},
"group_id": {
"type": "integer",
"description": "Collection group",
"example": 1
},
"articles_count": {
"type": "integer",
"description": "Number of articles in collection",
"example": 1
},
"public": {
"type": "boolean",
"description": "True if collection is published",
"example": true
},
"citation": {
"type": "string",
"description": "Collection citation",
"example": "citation"
},
"custom_fields": {
"type": "array",
"description": "Collection custom fields",
"items": {
"$ref": "#/components/schemas/CustomArticleField"
}
},
"modified_date": {
"type": "string",
"description": "Date when collection was last modified",
"example": "2017-05-15T15:12:26Z"
},
"created_date": {
"type": "string",
"description": "Date when collection was created",
"example": "2017-05-15T15:12:26Z"
},
"timeline": {
"$ref": "#/components/schemas/Timeline"
}
},
"allOf": [
{
"$ref": "#/components/schemas/Collection"
}
],
"x-tag": "collections"
},
"CollectionCompletePrivate": {
"required": [
"account_id",
"articles_count",
"authors",
"categories",
"citation",
"created_date",
"custom_fields",
"description",
"funding",
"group_id",
"institution_id",
"keywords",
"modified_date",
"public",
"references",
"resource_doi",
"resource_id",
"resource_link",
"resource_title",
"resource_version",
"tags",
"timeline",
"version"
],
"properties": {
"account_id": {
"type": "integer",
"description": "ID of the account owning the collection",
"example": 1000001
},
"funding": {
"type": "array",
"description": "Full Collection funding information",
"items": {
"$ref": "#/components/schemas/FundingInformation"
}
},
"resource_id": {
"type": "string",
"description": "Collection resource id",
"example": ""
},
"resource_doi": {
"type": "string",
"description": "Collection resource doi",
"example": "10.6084/m9.figshare.123"
},
"resource_title": {
"type": "string",
"description": "Collection resource title",
"example": "test"
},
"resource_link": {
"type": "string",
"description": "Collection resource link",
"example": "http://figshare.com"
},
"resource_version": {
"type": "integer",
"description": "Collection resource version",
"example": 0
},
"version": {
"type": "integer",
"description": "Collection version",
"example": 1
},
"description": {
"type": "string",
"description": "Collection description",
"example": "description"
},
"categories": {
"type": "array",
"description": "List of collection categories",
"items": {
"$ref": "#/components/schemas/Category"
}
},
"references": {
"type": "array",
"description": "List of collection references",
"items": {
"type": "string",
"format": "url"
}
},
"related_materials": {
"type": "array",
"description": "List of related materials; supersedes references and resource DOI/title.",
"example": [
{
"id": 10432,
"identifier": "10.6084/m9.figshare.1407024",
"identifier_type": "DOI",
"relation": "IsSupplementTo",
"title": "Figshare for institutions brochure",
"is_linkout": false
}
],
"items": {
"$ref": "#/components/schemas/RelatedMaterial"
}
},
"tags": {
"type": "array",
"description": "List of collection tags. Keywords can be used instead",
"example": [
"t1",
"t2"
],
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"description": "List of collection keywords. Tags can be used instead",
"example": [
"t1",
"t2"
],
"items": {
"type": "string"
}
},
"authors": {
"type": "array",
"description": "List of collection authors",
"items": {
"$ref": "#/components/schemas/Author"
}
},
"institution_id": {
"type": "integer",
"description": "Collection institution",
"example": 1
},
"group_id": {
"type": "integer",
"description": "Collection group",
"example": 1
},
"articles_count": {
"type": "integer",
"description": "Number of articles in collection",
"example": 1
},
"public": {
"type": "boolean",
"description": "True if collection is published",
"example": true
},
"citation": {
"type": "string",
"description": "Collection citation",
"example": "citation"
},
"custom_fields": {
"type": "array",
"description": "Collection custom fields",
"items": {
"$ref": "#/components/schemas/CustomArticleField"
}
},
"modified_date": {
"type": "string",
"description": "Date when collection was last modified",
"example": "2017-05-15T15:12:26Z"
},
"created_date": {
"type": "string",
"description": "Date when collection was created",
"example": "2017-05-15T15:12:26Z"
},
"timeline": {
"$ref": "#/components/schemas/Timeline"
}
},
"allOf": [
{
"$ref": "#/components/schemas/Collection"
}
],
"x-tag": "collections"
},
"CollectionCreate": {
"required": [
"title"
],
"type": "object",
"properties": {
"funding": {
"type": "string",
"description": "Grant number or funding authority",
"default": ""
},
"funding_list": {
"type": "array",
"description": "Funding creation / update items",
"items": {
"$ref": "#/components/schemas/FundingCreate"
}
},
"title": {
"maxLength": 1000,
"minLength": 3,
"type": "string",
"description": "Title of collection",
"example": "Test collection title"
},
"description": {
"maxLength": 20000,
"type": "string",
"description": "The collection description. In a publisher case, usually this is the remote collection description",
"example": "Test description of article",
"default": ""
},
"articles": {
"type": "array",
"description": "List of articles to be associated with the collection",
"example": [
2000001,
2000005
],
"items": {
"type": "integer"
}
},
"authors": {
"type": "array",
"description": "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.",
"example": [
{
"name": "John Doe"
},
{
"id": 20005
}
],
"items": {
"type": "object",
"properties": {}
}
},
"categories": {
"type": "array",
"description": "List of category ids to be associated with the collection(e.g [1, 23, 33, 66])",
"example": [
1,
10,
11
],
"items": {
"type": "integer"
}
},
"categories_by_source_id": {
"type": "array",
"description": "List of category source ids to be associated with the collection, supersedes the categories property",
"example": [
"300204",
"400207"
],
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"description": "List of tags to be associated with the collection. Keywords can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"description": "List of tags to be associated with the collection. Tags can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"description": "List of links to be associated with the collection (e.g [\"http://link1\", \"http://link2\", \"http://link3\"])",
"example": [
"http://figshare.com",
"http://api.figshare.com"
],
"items": {
"type": "string",
"format": "link"
}
},
"related_materials": {
"type": "array",
"description": "List of related materials; supersedes references and resource DOI/title.",
"example": [
{
"id": 10432,
"identifier": "10.6084/m9.figshare.1407024",
"identifier_type": "DOI",
"relation": "IsSupplementTo",
"title": "Figshare for institutions brochure",
"is_linkout": false
}
],
"items": {
"$ref": "#/components/schemas/RelatedMaterial"
}
},
"custom_fields": {
"type": "object",
"properties": {},
"description": "List of key, values pairs to be associated with the collection",
"example": {
"defined_key": "value for it"
}
},
"custom_fields_list": {
"type": "array",
"description": "List of custom fields values, supersedes custom_fields parameter",
"items": {
"$ref": "#/components/schemas/CustomArticleFieldAdd"
}
},
"doi": {
"type": "string",
"description": "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.",
"default": ""
},
"handle": {
"type": "string",
"description": "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.",
"default": ""
},
"resource_id": {
"type": "string",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article id"
},
"resource_doi": {
"type": "string",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article DOI.",
"default": ""
},
"resource_link": {
"type": "string",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article link"
},
"resource_title": {
"type": "string",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article title.",
"default": ""
},
"resource_version": {
"type": "integer",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article version"
},
"group_id": {
"type": "integer",
"description": "Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups"
},
"timeline": {
"$ref": "#/components/schemas/TimelineUpdate"
}
},
"x-tag": "collections"
},
"CollectionDOI": {
"required": [
"doi"
],
"type": "object",
"properties": {
"doi": {
"type": "string",
"description": "Reserved DOI",
"example": "10.5072/FK2.FIGSHARE.20345"
}
},
"x-tag": "collections"
},
"CollectionHandle": {
"required": [
"handle"
],
"type": "object",
"properties": {
"handle": {
"type": "string",
"description": "Reserved Handle",
"example": "11172/FK2.FIGSHARE.20345"
}
},
"x-tag": "collections"
},
"CollectionPrivateLinkCreator": {
"type": "object",
"properties": {
"expires_date": {
"type": "string",
"description": "Date when this private link should expire - optional. By default private links expire in 365 days.",
"example": "2018-02-22 22:22:22"
}
},
"x-tag": "collections"
},
"CollectionSearch": {
"properties": {
"resource_doi": {
"type": "string",
"description": "Only return collections with this resource_doi",
"example": "10.6084/m9.figshare.1407024"
},
"doi": {
"type": "string",
"description": "Only return collections with this doi",
"example": "10.6084/m9.figshare.1407024"
},
"handle": {
"type": "string",
"description": "Only return collections with this handle",
"example": "10084/figshare.1407024"
},
"order": {
"type": "string",
"description": "The field by which to order.",
"example": "published_date",
"default": "created_date",
"enum": [
"created_date",
"published_date",
"modified_date",
"views",
"shares",
"cites"
]
}
},
"allOf": [
{
"$ref": "#/components/schemas/CommonSearch"
}
],
"x-tag": "collections"
},
"CollectionUpdate": {
"type": "object",
"properties": {
"funding": {
"type": "string",
"description": "Grant number or funding authority",
"default": ""
},
"funding_list": {
"type": "array",
"description": "Funding creation / update items",
"items": {
"$ref": "#/components/schemas/FundingCreate"
}
},
"title": {
"maxLength": 1000,
"minLength": 3,
"type": "string",
"description": "Title of collection",
"example": "Test collection title"
},
"description": {
"maxLength": 20000,
"type": "string",
"description": "The collection description. In a publisher case, usually this is the remote collection description",
"example": "Test description of collection",
"default": ""
},
"articles": {
"type": "array",
"description": "List of articles to be associated with the collection",
"example": [
2000001,
2000005
],
"items": {
"type": "integer"
}
},
"authors": {
"type": "array",
"description": "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.",
"example": [
{
"name": "John Doe"
},
{
"id": 20005
}
],
"items": {
"type": "object",
"properties": {}
}
},
"categories": {
"type": "array",
"description": "List of category ids to be associated with the collection (e.g [1, 23, 33, 66])",
"example": [
1,
10,
11
],
"items": {
"type": "integer"
}
},
"categories_by_source_id": {
"type": "array",
"description": "List of category source ids to be associated with the article, supersedes the categories property",
"example": [
"300204",
"400207"
],
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"description": "List of tags to be associated with the collection. Keywords can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"description": "List of tags to be associated with the collection. Tags can be used instead",
"example": [
"tag1",
"tag2"
],
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"description": "List of links to be associated with the collection (e.g [\"http://link1\", \"http://link2\", \"http://link3\"])",
"example": [
"http://figshare.com",
"http://api.figshare.com"
],
"items": {
"type": "string",
"format": "link"
}
},
"related_materials": {
"type": "array",
"description": "List of related materials; supersedes references and resource DOI/title.",
"example": [
{
"id": 10432,
"identifier": "10.6084/m9.figshare.1407024",
"identifier_type": "DOI",
"relation": "IsSupplementTo",
"title": "Figshare for institutions brochure",
"is_linkout": false
}
],
"items": {
"$ref": "#/components/schemas/RelatedMaterial"
}
},
"custom_fields": {
"type": "object",
"properties": {},
"description": "List of key, values pairs to be associated with the collection",
"example": {
"defined_key": "value for it"
}
},
"custom_fields_list": {
"type": "array",
"description": "List of custom fields values, supersedes custom_fields parameter",
"items": {
"$ref": "#/components/schemas/CustomArticleFieldAdd"
}
},
"doi": {
"type": "string",
"description": "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.",
"default": ""
},
"handle": {
"type": "string",
"description": "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.",
"default": ""
},
"resource_id": {
"type": "string",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article id"
},
"resource_doi": {
"type": "string",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article DOI.",
"default": ""
},
"resource_link": {
"type": "string",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article link"
},
"resource_title": {
"type": "string",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article title.",
"default": ""
},
"resource_version": {
"type": "integer",
"description": "Not applicable to regular users. In a publisher case, this is the publisher article version"
},
"group_id": {
"type": "integer",
"description": "Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups"
},
"timeline": {
"$ref": "#/components/schemas/TimelineUpdate"
}
},
"x-tag": "collections"
},
"CollectionVersions": {
"required": [
"funding",
"url",
"version"
],
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Version number",
"example": 1
},
"url": {
"type": "string",
"description": "Api endpoint for the collection version",
"format": "url",
"example": "https://api.figshare.com/v2/collections/2000005/versions/1"
},
"funding": {
"type": "array",
"description": "Full Collection funding information",
"items": {
"$ref": "#/components/schemas/FundingInformation"
}
}
},
"x-tag": "collections"
},
"CommonSearch": {
"type": "object",
"properties": {
"search_for": {
"type": "string",
"description": "Search term",
"example": "figshare"
},
"page": {
"maximum": 5000,
"minimum": 1,
"type": "integer",
"description": "Page number. Used for pagination with page_size",
"example": 1
},
"page_size": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"description": "The number of results included on a page. Used for pagination with page",
"example": 10,
"default": 10
},
"limit": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"description": "Number of results included on a page. Used for pagination with query",
"example": 10
},
"offset": {
"maximum": 5000,
"minimum": 0,
"type": "integer",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"example": 0
},
"order_direction": {
"type": "string",
"description": "Direction of ordering",
"example": "desc",
"default": "desc",
"enum": [
"asc",
"desc"
]
},
"institution": {
"type": "integer",
"description": "only return collections from this institution",
"example": 2000013
},
"published_since": {
"type": "string",
"description": "Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ",
"example": "2017-12-22"
},
"modified_since": {
"type": "string",
"description": "Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ",
"example": "2017-12-22"
},
"group": {
"type": "integer",
"description": "only return collections from this group",
"example": 2000013
}
},
"x-tag": "common"
},
"ConfidentialityCreator": {
"required": [
"reason"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "Reason for confidentiality"
}
}
},
"CreateOAuthToken": {
"required": [
"client_id",
"client_secret",
"grant_type"
],
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"grant_type": {
"type": "string",
"enum": [
"authorization_code",
"refresh_token",
"password",
"client_credentials"
]
},
"code": {
"type": "string",
"description": "Required if grant_type is 'authorization_code'"
},
"refresh_token": {
"type": "string",
"description": "Required if grant_type is 'refresh_token'"
},
"username": {
"type": "string",
"description": "Required if grant_type is 'password'"
},
"password": {
"type": "string",
"description": "Required if grant_type is 'password'"
}
},
"x-tag": "oauth"
},
"CreateProjectResponse": {
"required": [
"entity_id",
"location"
],
"type": "object",
"properties": {
"entity_id": {
"type": "integer",
"description": "Figshare ID of the entity",
"example": 33334444
},
"location": {
"type": "string",
"description": "Url for entity",
"format": "url"
}
},
"x-tag": "common"
},
"Curation": {
"required": [
"account_id",
"article_id",
"assigned_to",
"comments_count",
"created_date",
"group_id",
"id",
"modified_date",
"request_number",
"resolution_comment",
"status",
"version"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The review id"
},
"group_id": {
"type": "integer",
"description": "The group in which the article is present."
},
"account_id": {
"type": "integer",
"description": "The ID of the account of the owner of the article of this review."
},
"assigned_to": {
"type": "integer",
"description": "The ID of the account to which this review is assigned."
},
"article_id": {
"type": "integer",
"description": "The ID of the article of this review."
},
"version": {
"type": "integer",
"description": "The Version number of the article in review."
},
"comments_count": {
"type": "integer",
"description": "The number of comments in the review."
},
"status": {
"type": "string",
"description": "The status of the review.",
"enum": [
"pending",
"approved",
"rejected",
"closed"
]
},
"created_date": {
"type": "string",
"description": "The creation date of the review."
},
"modified_date": {
"type": "string",
"description": "The date the review has been modified."
},
"request_number": {
"type": "integer",
"description": "The request number of the review."
},
"resolution_comment": {
"type": "string",
"description": "The resolution comment of the review."
}
},
"x-tag": "institutions"
},
"CurationComment": {
"required": [
"account_id",
"created_date",
"id",
"modified_date",
"text",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the comment."
},
"account_id": {
"type": "integer",
"description": "The ID of the account which generated this comment."
},
"type": {
"type": "string",
"description": "The ID of the account which generated this comment.",
"enum": [
"comment",
"approved",
"rejected",
"closed"
]
},
"text": {
"type": "string",
"description": "The value/content of the comment."
},
"created_date": {
"type": "string",
"description": "The creation date of the comment."
},
"modified_date": {
"type": "string",
"description": "The date the comment has been modified."
}
},
"x-tag": "institutions"
},
"CurationCommentCreate": {
"required": [
"text"
],
"type": "object",
"properties": {
"text": {
"maxLength": 2000,
"minLength": 1,
"type": "string",
"description": "The contents/value of the comment"
}
},
"x-tag": "institutions"
},
"CurationDetail": {
"required": [
"item"
],
"properties": {
"item": {
"$ref": "#/components/schemas/ArticleComplete"
}
},
"allOf": [
{
"$ref": "#/components/schemas/Curation"
}
],
"x-tag": "institutions"
},
"CustomArticleField": {
"required": [
"field_type",
"is_mandatory",
"name",
"order",
"settings",
"value"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Custom metadata name",
"example": "key"
},
"value": {
"type": "object",
"description": "Custom metadata value (can be either a string or an array of strings)",
"example": "value"
},
"field_type": {
"type": "string",
"description": "Custom field type",
"example": "textarea",
"enum": [
"text",
"textarea",
"dropdown",
"url",
"email",
"date",
"dropdown_large_list"
]
},
"settings": {
"type": "object",
"properties": {},
"description": "Settings for the custom field",
"example": {
"validations": {
"min_length": 1,
"max_length": 1000
},
"placeholder": "Enter your custom field here"
}
},
"order": {
"type": "integer",
"description": "Order of the custom field",
"example": 1
},
"is_mandatory": {
"type": "boolean",
"description": "Whether the field is mandatory or not",
"example": false
}
},
"x-tag": "articles"
},
"CustomArticleFieldAdd": {
"required": [
"name",
"value"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Custom metadata name",
"example": "key"
},
"value": {
"description": "Custom metadata value (can be either a string, an array of strings, or empty)",
"example": "value",
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object"
}
]
}
},
"x-tag": "articles"
},
"ErrorMessage": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "A machine friendly error code, used by the dev team to identify the error."
},
"message": {
"type": "string",
"description": "A human friendly message explaining the error."
}
},
"x-tag": "common"
},
"FileCreator": {
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Url for an existing file that will not be uploaded to Figshare",
"example": "http://figshare.com/file.txt"
},
"md5": {
"type": "string",
"description": "MD5 sum pre-computed on client side.",
"example": "6c16e6e7d7587bd078e5117dda01d565"
},
"name": {
"type": "string",
"description": "File name including the extension; can be omitted only for linked files.",
"example": "test.py"
},
"size": {
"type": "integer",
"description": "File size in bytes; can be omitted only for linked files.",
"example": 70
},
"folder_path": {
"type": "string",
"description": "Unix-style directory path of the file; only available if the file was uploaded within a folder structure",
"example": "/level1/level2/level3"
}
},
"x-tag": "articles"
},
"FileId": {
"type": "object",
"properties": {
"file_id": {
"type": "integer",
"description": "File ID",
"example": 123
}
},
"x-tag": "articles"
},
"FundingCreate": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "A funding ID as returned by the Funding Search endpoint"
},
"title": {
"type": "string",
"description": "The title of the new user created funding"
}
},
"x-tag": "funding"
},
"FundingInformation": {
"required": [
"funder_name",
"grant_code",
"id",
"is_user_defined",
"title",
"url"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Funding id",
"example": 1
},
"title": {
"type": "string",
"description": "The funding name",
"example": "Scholarly funding"
},
"grant_code": {
"type": "string",
"description": "The grant code"
},
"funder_name": {
"type": "string",
"description": "Funder's name"
},
"is_user_defined": {
"type": "integer",
"description": "Return 1 whether the grant has been introduced manually, 0 otherwise"
},
"url": {
"type": "string",
"description": "The grant url",
"format": "url",
"example": "https://app.dimensions.ai/details/grant/1"
}
},
"x-tag": "funding"
},
"FundingSearch": {
"type": "object",
"properties": {
"search_for": {
"type": "string",
"description": "Search term"
}
},
"x-tag": "funding"
},
"Group": {
"required": [
"association_criteria",
"id",
"name",
"parent_id",
"resource_id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Group id",
"example": 1
},
"name": {
"type": "string",
"description": "Group name",
"example": "Materials"
},
"resource_id": {
"type": "string",
"description": "Group resource id",
"example": ""
},
"parent_id": {
"type": "integer",
"description": "Parent group if any",
"example": 0
},
"association_criteria": {
"type": "string",
"description": "HR code associated with group, if code exists",
"example": "IT"
}
},
"x-tag": "institutions"
},
"GroupEmbargoOptions": {
"required": [
"id",
"ip_name",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Embargo option id",
"example": 364
},
"type": {
"type": "string",
"description": "Embargo permission type",
"example": "ip_range",
"enum": [
"logged_in",
"ip_range",
"administrator"
]
},
"ip_name": {
"type": "string",
"description": "IP range name; value appears if type is ip_range",
"example": "Figshare IP range"
}
},
"x-tag": "institutions"
},
"Institution": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Institution id",
"example": 0
},
"name": {
"type": "string",
"description": "Institution name",
"example": "Institution"
}
},
"x-tag": "institutions"
},
"InstitutionAccountsSearch": {
"type": "object",
"properties": {
"search_for": {
"type": "string",
"description": "Search term",
"example": "figshare"
},
"is_active": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Filter by active status"
},
"page": {
"maximum": 5000,
"minimum": 1,
"type": "integer",
"description": "Page number. Used for pagination with page_size",
"example": 1
},
"page_size": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"description": "The number of results included on a page. Used for pagination with page",
"example": 10,
"default": 10
},
"limit": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"description": "Number of results included on a page. Used for pagination with query",
"example": 10
},
"offset": {
"maximum": 5000,
"minimum": 0,
"type": "integer",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"example": 0
},
"institution_user_id": {
"type": "string",
"description": "filter by institution_user_id",
"example": "alan"
},
"email": {
"type": "string",
"description": "filter by email",
"example": "alan@institution.com"
}
},
"x-tag": "institutions"
},
"ItemType": {
"required": [
"icon",
"id",
"is_selectable",
"name",
"public_description",
"string_id",
"url_name"
],
"type": "object",
"properties": {
"id": {
"minimum": 1,
"type": "integer",
"description": "The ID of the item type."
},
"name": {
"type": "string",
"description": "The name of the item type",
"example": "journal contribution"
},
"string_id": {
"type": "string",
"description": "The string identifier of the item type.",
"example": "journal_contribution"
},
"icon": {
"type": "string",
"description": "The string identifying the icon of the item type.",
"example": "paper"
},
"public_description": {
"type": "string",
"description": "The description of the item type.",
"example": "This is the description of an item type"
},
"is_selectable": {
"type": "boolean",
"description": "The selectable status",
"example": true
},
"url_name": {
"type": "string",
"description": "The URL name of the item type.",
"example": "journal_contribution"
}
}
},
"License": {
"required": [
"name",
"url",
"value"
],
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "License value",
"example": 1
},
"name": {
"type": "string",
"description": "License name",
"example": "CC BY"
},
"url": {
"type": "string",
"description": "License url",
"format": "url",
"example": "http://creativecommons.org/licenses/by/4.0/"
}
},
"x-tag": "institutions"
},
"Location": {
"required": [
"location"
],
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Url for item",
"format": "url"
}
},
"x-tag": "common"
},
"LocationWarnings": {
"required": [
"entity_id",
"location",
"warnings"
],
"type": "object",
"properties": {
"entity_id": {
"type": "integer",
"description": "Figshare ID of the entity",
"example": 33334444
},
"location": {
"type": "string",
"description": "Url for entity",
"format": "url"
},
"warnings": {
"type": "array",
"description": "Issues encountered during the operation",
"items": {
"type": "string"
}
}
},
"x-tag": "common"
},
"LocationWarningsUpdate": {
"required": [
"location",
"warnings"
],
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Url for entity",
"format": "url"
},
"warnings": {
"type": "array",
"description": "Issues encountered during the operation",
"items": {
"type": "string"
}
}
},
"x-tag": "common"
},
"OAuthToken": {
"required": [
"access_token",
"expires_in",
"token_type"
],
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "The OAuth access token",
"example": "abcd1234567890efgh"
},
"token": {
"type": "string",
"description": "The OAuth access token",
"example": "abcd1234567890efgh"
},
"token_type": {
"type": "string",
"description": "The type of token issued",
"example": "bearer"
},
"expires_in": {
"type": "integer",
"description": "Token expiration time in seconds",
"example": 3600
},
"refresh_token": {
"type": "string",
"description": "The refresh token (only provided for certain grant types)",
"example": "refresh_abcd1234567890efgh"
},
"scope": {
"type": "string",
"description": "The scope of the access token",
"example": "all"
}
},
"x-tag": "oauth"
},
"PrivateArticleSearch": {
"properties": {
"resource_id": {
"type": "string",
"description": "only return collections with this resource_id",
"example": "1407024"
}
},
"allOf": [
{
"$ref": "#/components/schemas/ArticleSearch"
}
],
"x-tag": "articles"
},
"PrivateAuthorsSearch": {
"type": "object",
"properties": {
"search_for": {
"type": "string",
"description": "Search term",
"example": "figshare"
},
"page": {
"maximum": 5000,
"minimum": 1,
"type": "integer",
"description": "Page number. Used for pagination with page_size",
"example": 1
},
"page_size": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"description": "The number of results included on a page. Used for pagination with page",
"example": 10,
"default": 10
},
"limit": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"description": "Number of results included on a page. Used for pagination with query",
"example": 10
},
"offset": {
"maximum": 5000,
"minimum": 0,
"type": "integer",
"description": "Where to start the listing (the offset of the first result). Used for pagination with limit",
"example": 0
},
"institution_id": {
"minimum": 0,
"type": "integer",
"description": "Return only authors associated to this institution",
"example": 1
},
"orcid": {
"type": "string",
"description": "Orcid of author"
},
"group_id": {
"minimum": 0,
"type": "integer",
"description": "Return only authors in this group or subgroups of the group"
},
"is_active": {
"type": "boolean",
"description": "Return only active authors if True"
},
"is_public": {
"type": "boolean",
"description": "Return only authors that have published items if True"
}
},
"x-tag": "authors"
},
"PrivateCollectionSearch": {
"properties": {
"resource_id": {
"type": "string",
"description": "only return collections with this resource_id",
"example": "1407024"
}
},
"allOf": [
{
"$ref": "#/components/schemas/CollectionSearch"
}
],
"x-tag": "collections"
},
"PrivateFile": {
"required": [
"is_attached_to_public_version",
"preview_state",
"upload_token",
"upload_url",
"viewer_type"
],
"properties": {
"viewer_type": {
"type": "string",
"description": "File viewer type"
},
"preview_state": {
"type": "string",
"description": "File preview state",
"example": "preview not available"
},
"upload_url": {
"type": "string",
"description": "Upload url for file",
"format": "url",
"example": "https://uploads.figshare.com"
},
"upload_token": {
"type": "string",
"description": "Token for file upload",
"example": "9dfc5fe3-d617-4d93-ac11-8afe7e984a4b"
},
"is_attached_to_public_version": {
"type": "boolean",
"description": "True if the file is attached to a public item version",
"example": true
}
},
"allOf": [
{
"$ref": "#/components/schemas/PublicFile"
}
],
"x-tag": "common"
},
"PrivateLink": {
"required": [
"expires_date",
"html_location",
"id",
"is_active"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Private link id",
"example": "0cfb0dbeac92df445df4aba45f63fdc85fa0b9a888b64e157ce3c93b576aa300fb3621ef3a219515dd482"
},
"is_active": {
"type": "boolean",
"description": "True if private link is active",
"example": true
},
"expires_date": {
"type": "string",
"description": "Date when link will expire",
"example": "2015-07-03T00:00:00"
},
"html_location": {
"type": "string",
"description": "HTML url for private link",
"format": "url",
"example": "https://figshare.com/s/d5ec7a85bcd6dbe9d9b2"
}
},
"x-tag": "articles"
},
"PrivateLinkCreator": {
"type": "object",
"properties": {
"expires_date": {
"type": "string",
"description": "Date when this private link should expire - optional. By default private links expire in 365 days.",
"example": "2018-02-22 22:22:22"
}
},
"x-tag": "articles"
},
"PrivateLinkResponse": {
"required": [
"html_location",
"location",
"token"
],
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Url for private link",
"format": "url"
},
"html_location": {
"type": "string",
"description": "HTML url for private link",
"format": "url",
"example": "https://figshare.com/s/d5ec7a85bcd6dbe9d9b2"
},
"token": {
"type": "string",
"description": "Token for private link",
"example": "d5ec7a85bcd6dbe9d9b2"
}
},
"x-tag": "common"
},
"PrivateProjectArticle": {
"required": [
"account_id",
"authors",
"curation_status",
"custom_fields",
"download_disabled",
"embargo_options",
"figshare_url",
"files"
],
"properties": {
"files": {
"type": "array",
"description": "List of up to 10 article files.",
"items": {
"$ref": "#/components/schemas/PublicFile"
}
},
"embargo_options": {
"type": "array",
"description": "List of embargo options",
"items": {
"$ref": "#/components/schemas/GroupEmbargoOptions"
}
},
"custom_fields": {
"type": "array",
"description": "List of custom fields values",
"items": {
"$ref": "#/components/schemas/CustomArticleField"
}
},
"account_id": {
"type": "integer",
"description": "ID of the account owning the article",
"example": 1000001
},
"download_disabled": {
"type": "boolean",
"description": "If true, downloading of files for this article is disabled",
"example": false
},
"authors": {
"type": "array",
"description": "List of authors",
"items": {
"$ref": "#/components/schemas/Author"
}
},
"figshare_url": {
"type": "string",
"description": "Article public url",
"format": "url",
"example": "http://figshare.com/articles/media/article_name/2000005"
},
"curation_status": {
"type": "string",
"description": "Curation status of the article",
"example": "approved"
}
},
"allOf": [
{
"$ref": "#/components/schemas/ProjectArticle"
}
],
"x-tag": "articles"
},
"ProfileUpdateData": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "First name",
"example": "John"
},
"last_name": {
"type": "string",
"description": "Last Name",
"example": "Doe"
},
"orcid": {
"type": "string",
"description": "User ORCID",
"example": "0000-0001-YYYY-XXXX"
},
"job_title": {
"type": "string",
"description": "User job title",
"example": "Researcher at institution X"
},
"fields_of_interest": {
"type": "array",
"description": "User fields of interest (category ids)",
"example": [
1,
2
],
"items": {
"type": "integer",
"description": "Id of category"
}
},
"fields_of_interest_by_source_id": {
"type": "array",
"description": "User fields of interest (category source IDs), supersedes the fields_of_interest property",
"example": [
"3204",
"320401"
],
"items": {
"type": "string",
"description": "Source ID of category"
}
},
"location": {
"type": "string",
"description": "User location",
"example": "London, UK"
},
"facebook": {
"type": "string",
"description": "User facebook URL",
"format": "url",
"example": "https://facebook.com/profile/1"
},
"x": {
"type": "string",
"description": "User X (twitter) URL",
"format": "url",
"example": "https://x.com/profile/1"
},
"linkedin": {
"type": "string",
"description": "User linkedin URL",
"format": "url",
"example": "https://linkedin.com/profile/2"
},
"bio": {
"type": "string",
"description": "User biographical information",
"example": "Biographical information"
},
"personal_profiles": {
"type": "array",
"description": "Add up to 10 additional personal profile links",
"example": [
{
"label": "ResearchGate",
"url": "https://researchgate.net/profile/1"
},
{
"label": "",
"url": "https://academia.edu/profile/1"
}
],
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label for the personal profile link",
"example": "ResearchGate"
},
"url": {
"type": "string",
"description": "URL for the personal profile link",
"format": "url",
"example": "https://researchgate.net/profile/1"
}
}
}
}
},
"x-tag": "profiles"
},
"Project": {
"required": [
"created_date",
"id",
"modified_date",
"title",
"url"
],
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Api endpoint",
"example": "http://api.figshare.com/v2/account/projects/1"
},
"id": {
"type": "integer",
"description": "Project id",
"example": 1
},
"title": {
"type": "string",
"description": "Project title",
"example": "project"
},
"created_date": {
"type": "string",
"description": "Date when project was created",
"example": "2017-05-16T14:52:54Z"
},
"modified_date": {
"type": "string",
"description": "Date when project was last modified",
"example": "2017-05-16T14:52:54Z"
}
},
"x-tag": "projects"
},
"ProjectArticle": {
"required": [
"categories",
"citation",
"confidential_reason",
"created_date",
"description",
"embargo_reason",
"embargo_title",
"funding",
"funding_list",
"has_linked_file",
"is_confidential",
"is_embargoed",
"is_metadata_record",
"is_public",
"keywords",
"license",
"metadata_reason",
"references",
"size",
"status",
"tags",
"version"
],
"properties": {
"citation": {
"type": "string",
"description": "Article citation",
"example": "lilliput, figshare admin (2017): first project item. figshare.\n \n Retrieved: 14 01, May 22, 2017 (GMT)"
},
"confidential_reason": {
"type": "string",
"description": "Confidentiality reason",
"example": "none"
},
"is_confidential": {
"type": "boolean",
"description": "Article Confidentiality",
"example": true
},
"size": {
"type": "integer",
"description": "Article size",
"example": 69939
},
"funding": {
"type": "string",
"description": "Article funding",
"example": "none"
},
"funding_list": {
"type": "array",
"description": "Full Article funding information",
"items": {
"$ref": "#/components/schemas/FundingInformation"
}
},
"tags": {
"type": "array",
"description": "List of article tags. Keywords can be used instead",
"example": [
"t1",
"t2",
"t3"
],
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"description": "List of article keywords. Tags can be used instead",
"example": [
"t1",
"t2",
"t3"
],
"items": {
"type": "string"
}
},
"version": {
"type": "integer",
"description": "Article version",
"example": 1
},
"is_metadata_record": {
"type": "boolean",
"description": "True if article has no files",
"example": false
},
"metadata_reason": {
"type": "string",
"description": "Article metadata reason",
"example": "hosted somewhere else"
},
"status": {
"type": "string",
"description": "Article status",
"example": "public"
},
"description": {
"type": "string",
"description": "Article description",
"example": "article description"
},
"is_embargoed": {
"type": "boolean",
"description": "True if article is embargoed",
"example": true
},
"is_public": {
"type": "boolean",
"description": "True if article is published",
"example": true
},
"created_date": {
"type": "string",
"description": "Date when article was created",
"example": "2017-05-18T11:49:03Z"
},
"has_linked_file": {
"type": "boolean",
"description": "True if any files are linked to the article",
"example": true
},
"categories": {
"type": "array",
"description": "List of categories selected for the article",
"items": {
"$ref": "#/components/schemas/Category"
}
},
"license": {
"$ref": "#/components/schemas/License"
},
"embargo_title": {
"type": "string",
"description": "Title for embargo",
"example": "File(s) under embargo"
},
"embargo_reason": {
"type": "string",
"description": "Reason for embargo",
"example": "not complete"
},
"references": {
"type": "array",
"description": "List of references",
"example": [
"http://figshare.com",
"http://figshare.com/api"
],
"items": {
"type": "string",
"format": "url"
}
},
"related_materials": {
"type": "array",
"description": "List of related materials; supersedes references and resource DOI/title.",
"example": [
{
"id": 10432,
"identifier": "10.6084/m9.figshare.1407024",
"identifier_type": "DOI",
"relation": "IsSupplementTo",
"title": "Figshare for institutions brochure",
"is_linkout": false
}
],
"items": {
"$ref": "#/components/schemas/RelatedMaterial"
}
}
},
"allOf": [
{
"$ref": "#/components/schemas/Article"
}
],
"x-tag": "articles"
},
"ProjectCollaborator": {
"required": [
"name",
"role_name",
"status",
"user_id"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of collaborator invitation",
"example": "invited"
},
"role_name": {
"type": "string",
"description": "Collaborator role",
"example": "Owner"
},
"user_id": {
"type": "integer",
"description": "Collaborator id",
"example": 1
},
"name": {
"type": "string",
"description": "Collaborator name",
"example": "name"
}
},
"x-tag": "projects"
},
"ProjectCollaboratorInvite": {
"required": [
"role_name"
],
"type": "object",
"properties": {
"role_name": {
"type": "string",
"description": "Role of the the collaborator inside the project",
"example": "viewer",
"enum": [
"viewer",
"collaborator"
]
},
"user_id": {
"type": "integer",
"description": "User id of the collaborator",
"example": 100008
},
"email": {
"type": "string",
"description": "Collaborator email",
"example": "user@domain.com"
},
"comment": {
"type": "string",
"description": "Text sent when inviting the user to the project",
"example": "hey"
}
},
"x-tag": "projects"
},
"ProjectComplete": {
"required": [
"collaborators",
"created_date",
"custom_fields",
"description",
"funding",
"funding_list",
"modified_date"
],
"properties": {
"funding": {
"type": "string",
"description": "Project funding",
"example": ""
},
"funding_list": {
"type": "array",
"description": "Full Project funding information",
"items": {
"$ref": "#/components/schemas/FundingInformation"
}
},
"description": {
"type": "string",
"description": "Project description",
"example": "description"
},
"collaborators": {
"type": "array",
"description": "List of project collaborators",
"items": {
"$ref": "#/components/schemas/Collaborator"
}
},
"custom_fields": {
"type": "array",
"description": "Project custom fields",
"items": {
"$ref": "#/components/schemas/CustomArticleField"
}
},
"modified_date": {
"type": "string",
"description": "Date when project was last modified",
"example": "2017-05-16T14:52:54Z"
},
"created_date": {
"type": "string",
"description": "Date when project was created",
"example": "2017-05-16T14:52:54Z"
}
},
"allOf": [
{
"$ref": "#/components/schemas/Project"
}
],
"x-tag": "projects"
},
"ProjectCompletePrivate": {
"required": [
"account_id",
"collaborators",
"created_date",
"custom_fields",
"description",
"funding",
"funding_list",
"group_id",
"modified_date",
"quota",
"used_quota",
"used_quota_private",
"used_quota_public"
],
"properties": {
"funding": {
"type": "string",
"description": "Project funding",
"example": "none"
},
"funding_list": {
"type": "array",
"description": "Full Project funding information",
"items": {
"$ref": "#/components/schemas/FundingInformation"
}
},
"description": {
"type": "string",
"description": "Project description",
"example": "description"
},
"collaborators": {
"type": "array",
"description": "List of project collaborators",
"items": {
"$ref": "#/components/schemas/Collaborator"
}
},
"quota": {
"type": "integer",
"description": "Project quota",
"example": 0
},
"used_quota": {
"type": "integer",
"description": "Project used quota",
"example": 0
},
"created_date": {
"type": "string",
"description": "Date when project was created",
"example": "2017-05-16T14:52:54Z"
},
"modified_date": {
"type": "string",
"description": "Date when project was last modified",
"example": "2017-05-16T14:52:54Z"
},
"used_quota_private": {
"type": "integer",
"description": "Project private quota used",
"example": 0
},
"used_quota_public": {
"type": "integer",
"description": "Project public quota used",
"example": 0
},
"group_id": {
"type": "integer",
"description": "Group of project if any",
"example": 0
},
"account_id": {
"type": "integer",
"description": "ID of the account owning the project",
"example": 1000001
},
"custom_fields": {
"type": "array",
"description": "Collection custom fields",
"items": {
"$ref": "#/components/schemas/ShortCustomField"
}
}
},
"allOf": [
{
"$ref": "#/components/schemas/ProjectPrivate"
}
],
"x-tag": "projects"
},
"ProjectCreate": {
"required": [
"title"
],
"type": "object",
"properties": {
"title": {
"maxLength": 1000,
"minLength": 3,
"type": "string",
"description": "The title for this project - mandatory. 3 - 1000 characters.",
"example": "project title"
},
"description": {
"maxLength": 20000,
"type": "string",
"description": "Project description",
"example": "project description"
},
"funding": {
"type": "string",
"description": "Grant number or organization(s) that funded this project. Up to 2000 characters permitted.",
"example": ""
},
"funding_list": {
"type": "array",
"description": "Funding creation / update items",
"items": {
"$ref": "#/components/schemas/FundingCreate"
}
},
"group_id": {
"type": "integer",
"description": "Only if project type is group.",
"example": 0
},
"custom_fields": {
"type": "object",
"properties": {},
"description": "List of key, values pairs to be associated with the project",
"example": {
"defined_key": "value for it"
}
},
"custom_fields_list": {
"type": "array",
"description": "List of custom fields values, supersedes custom_fields parameter",
"items": {
"$ref": "#/components/schemas/CustomArticleFieldAdd"
}
}
},
"x-tag": "projects"
},
"ProjectNote": {
"required": [
"abstract",
"created_date",
"id",
"modified_date",
"user_id",
"user_name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Project note id",
"example": 1
},
"user_id": {
"type": "integer",
"description": "User who wrote the note",
"example": 100008
},
"abstract": {
"type": "string",
"description": "Note Abstract - short/truncated content",
"example": "text"
},
"user_name": {
"type": "string",
"description": "Username of the one who wrote the note",
"example": "user"
},
"created_date": {
"type": "string",
"description": "Date when note was created",
"example": "2017-05-16T16:49:11Z"
},
"modified_date": {
"type": "string",
"description": "Date when note was last modified",
"example": "2017-05-16T16:49:11Z"
}
},
"x-tag": "projects"
},
"ProjectNoteCreate": {
"required": [
"text"
],
"type": "object",
"properties": {
"text": {
"minLength": 3,
"type": "string",
"description": "Text of the note",
"example": "note to remember"
}
},
"x-tag": "projects"
},
"ProjectNotePrivate": {
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"description": "Full text of note",
"example": "text"
}
},
"allOf": [
{
"$ref": "#/components/schemas/ProjectNote"
}
],
"x-tag": "projects"
},
"ProjectPrivate": {
"required": [
"role",
"storage"
],
"properties": {
"role": {
"type": "string",
"description": "Role inside this project",
"example": "Owner",
"enum": [
"Owner",
"Collaborator",
"Viewer"
]
},
"storage": {
"type": "string",
"description": "Project storage type",
"example": "individual",
"enum": [
"individual",
"group"
]
}
},
"allOf": [
{
"$ref": "#/components/schemas/Project"
}
],
"x-tag": "projects"
},
"ProjectsSearch": {
"properties": {
"order": {
"type": "string",
"description": "The field by which to order.",
"example": "published_date",
"default": "published_date",
"enum": [
"published_date",
"modified_date",
"views"
]
}
},
"allOf": [
{
"$ref": "#/components/schemas/CommonSearch"
}
],
"x-tag": "projects"
},
"ProjectUpdate": {
"type": "object",
"properties": {
"title": {
"maxLength": 1000,
"minLength": 3,
"type": "string",
"description": "The title for this project - mandatory. 3 - 1000 characters.",
"example": "project title"
},
"description": {
"maxLength": 20000,
"type": "string",
"description": "Project description",
"example": "project description"
},
"funding": {
"type": "string",
"description": "Grant number or organization(s) that funded this project. Up to 2000 characters permitted.",
"example": ""
},
"funding_list": {
"type": "array",
"description": "Funding creation / update items",
"items": {
"$ref": "#/components/schemas/FundingCreate"
}
},
"custom_fields": {
"type": "object",
"properties": {},
"description": "List of key, values pairs to be associated with the project",
"example": {
"defined_key": "value for it"
}
},
"custom_fields_list": {
"type": "array",
"description": "List of custom fields values, supersedes custom_fields parameter",
"items": {
"$ref": "#/components/schemas/CustomArticleFieldAdd"
}
}
},
"x-tag": "projects"
},
"PublicFile": {
"required": [
"computed_md5",
"download_url",
"id",
"is_link_only",
"name",
"size",
"supplied_md5"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "File id",
"example": 3000002
},
"name": {
"type": "string",
"description": "File name",
"example": "test.xls"
},
"size": {
"type": "integer",
"description": "File size",
"example": 14848
},
"is_link_only": {
"type": "boolean",
"description": "True if file is hosted somewhere else",
"example": false
},
"download_url": {
"type": "string",
"description": "Url for file download",
"format": "url",
"example": "https://ndownloader.figshare.com/files/3000002"
},
"supplied_md5": {
"type": "string",
"description": "File supplied md5",
"example": "043a51806d646e88cafbf19e7b82846f"
},
"computed_md5": {
"type": "string",
"description": "File computed md5",
"example": "043a51806d646e88cafbf19e7b82846f"
},
"mimetype": {
"type": "string",
"description": "MIME Type of the file, it defaults to an empty string",
"example": "application/pdf"
}
},
"x-tag": "common"
},
"RelatedMaterial": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the related material; can be used to add existing materials of the same account to items.",
"example": 10432
},
"identifier": {
"type": "string",
"description": "The related material identifier (e.g., DOI, Handle, ISBN). Mandatory if creating a new material.",
"example": "10.6084/m9.figshare.1407024"
},
"title": {
"type": "string",
"description": "The related material title",
"example": "Rooter: A Methodology for the Typical Unification of Access Points and Redundancy"
},
"relation": {
"type": "string",
"description": "The relation between the item and the related material; defaults to 'References'. Mandatory if creating a new material.",
"example": "IsSupplementTo",
"default": "References",
"enum": [
"IsCitedBy",
"Cites",
"IsSupplementTo",
"IsSupplementedBy",
"IsContinuedBy",
"Continues",
"Describes",
"IsDescribedBy",
"HasMetadata",
"IsMetadataFor",
"HasVersion",
"IsVersionOf",
"IsNewVersionOf",
"IsPreviousVersionOf",
"IsPartOf",
"HasPart",
"IsPublishedIn",
"IsReferencedBy",
"References",
"IsDocumentedBy",
"Documents",
"IsCompiledBy",
"Compiles",
"IsVariantFormOf",
"IsOriginalFormOf",
"IsIdenticalTo",
"IsReviewedBy",
"Reviews",
"IsDerivedFrom",
"IsSourceOf",
"IsRequiredBy",
"Requires",
"IsObsoletedBy",
"Obsoletes"
]
},
"identifier_type": {
"type": "string",
"description": "The type of the identifier of the related material; defaults to 'URL'. Mandatory if creating a new material.",
"example": "DOI",
"default": "URL",
"enum": [
"ARK",
"arXiv",
"bibcode",
"DOI",
"EAN13",
"EISSN",
"Handle",
"IGSN",
"ISBN",
"ISSN",
"ISTC",
"LISSN",
"LSID",
"PMID",
"PURL",
"UPC",
"URL",
"URN",
"w3id"
]
},
"is_linkout": {
"type": "boolean",
"description": "Flag for highlighting this related material in the call-out box",
"example": true
},
"link": {
"type": "string",
"description": "The full hyperlink for the identifier. Automatically generated by Figshare.",
"readOnly": true,
"example": "https://doi.org/10.6084/m9.figshare.1407024"
}
}
},
"Resource": {
"type": "object",
"properties": {
"id": {
"maxLength": 255,
"type": "string",
"description": "ID of resource item",
"example": "aaaa23512",
"default": ""
},
"title": {
"maxLength": 1000,
"type": "string",
"description": "Title of resource item",
"example": "Test title",
"default": ""
},
"doi": {
"type": "string",
"description": "DOI of resource item",
"default": ""
},
"link": {
"maxLength": 255,
"type": "string",
"description": "Link of resource item",
"example": "https://docs.figshare.com",
"default": ""
},
"status": {
"maxLength": 100,
"type": "string",
"description": "Status of resource item",
"example": "frozen",
"default": ""
},
"version": {
"type": "integer",
"description": "Version of resource item",
"example": 1,
"default": 0
}
},
"x-tag": "resource"
},
"ResponseMessage": {
"required": [
"message"
],
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Response message text",
"example": "Project 1 has been published"
}
},
"x-tag": "common"
},
"Role": {
"required": [
"category",
"description",
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Role id",
"example": 1
},
"name": {
"type": "string",
"description": "Role name",
"example": "Curator"
},
"category": {
"type": "string",
"description": "Role category",
"example": "group"
},
"description": {
"type": "string",
"description": "Role description"
}
},
"x-tag": "institutions"
},
"ShortAccount": {
"required": [
"active",
"email",
"first_name",
"id",
"institution_id",
"institution_user_id",
"last_name",
"orcid_id",
"quota",
"symplectic_user_id",
"used_quota",
"user_id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Account id",
"example": 1495682
},
"first_name": {
"type": "string",
"description": "First Name",
"example": "Doe"
},
"last_name": {
"type": "string",
"description": "Last Name",
"example": "John"
},
"institution_id": {
"type": "integer",
"description": "Account institution",
"example": 1
},
"email": {
"type": "string",
"description": "User email",
"example": "user@domain.com"
},
"active": {
"type": "integer",
"description": "Account activity status",
"example": 0
},
"institution_user_id": {
"type": "string",
"description": "Account institution user id",
"example": "1"
},
"quota": {
"type": "integer",
"description": "Total storage available to account, in bytes",
"example": 1074000000
},
"used_quota": {
"type": "integer",
"description": "Storage used by the account, in bytes",
"example": 1074000000
},
"user_id": {
"type": "integer",
"description": "User id associated with account, useful for example for adding the account as an author to an item",
"example": 1000001
},
"orcid_id": {
"type": "string",
"description": "ORCID iD associated to account",
"example": "0000-0001-2345-6789"
},
"symplectic_user_id": {
"type": "string",
"description": "Symplectic ID associated to account",
"example": "djohn42"
}
},
"x-tag": "other"
},
"ShortCustomField": {
"required": [
"field_type",
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Custom field id",
"example": 365
},
"name": {
"type": "string",
"description": "Custom field name",
"example": "my custom field"
},
"field_type": {
"type": "string",
"description": "Custom field type",
"example": "textarea",
"enum": [
"text",
"textarea",
"dropdown",
"url",
"email",
"date",
"dropdown_large_list"
]
},
"settings": {
"type": "object",
"properties": {},
"description": "Settings for the custom field",
"example": {
"validations": {
"min_length": 1,
"max_length": 1000
},
"placeholder": "Enter your custom field here"
}
},
"order": {
"type": "integer",
"description": "Order of the field in the group",
"example": 1
},
"is_mandatory": {
"type": "boolean",
"description": "Whether the field is mandatory or not",
"example": false
}
},
"x-tag": "institutions"
},
"Timeline": {
"allOf": [
{
"$ref": "#/components/schemas/TimelineUpdate"
}
],
"x-tag": "timeline"
},
"TimelineUpdate": {
"type": "object",
"properties": {
"firstOnline": {
"type": "string",
"description": "Online posted date",
"example": "2015-12-31"
},
"publisherPublication": {
"type": "string",
"description": "Publish date",
"example": "2015-12-31"
},
"publisherAcceptance": {
"type": "string",
"description": "Date when the item was accepted for publication",
"example": "2015-12-31"
}
},
"x-tag": "timeline_update"
},
"UploadFilePart": {
"type": "object",
"properties": {
"partNo": {
"type": "integer",
"description": "File part id",
"example": 1
},
"startOffset": {
"type": "integer",
"description": "Indexes on byte range. zero-based and inclusive",
"example": 0
},
"endOffset": {
"type": "integer",
"description": "Indexes on byte range. zero-based and inclusive",
"example": 69
},
"status": {
"type": "string",
"description": "part status",
"enum": [
"PENDING",
"COMPLETE"
]
},
"locked": {
"type": "boolean",
"description": "When a part is being uploaded it is being locked, by setting the locked flag to true. No changes/uploads can happen on this part from other requests."
}
},
"x-tag": "upload"
},
"UploadInfo": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "token received after initializing a file upload",
"example": "693a2802-cd61-430d-b89f-507f0f6d8fd3"
},
"md5": {
"type": "string",
"description": "md5 provided on upload initialization",
"example": "3a7f451c068f4e13260034c611378140"
},
"size": {
"type": "integer",
"description": "size of file in bytes",
"example": 70
},
"name": {
"type": "string",
"description": "name of file on upload server",
"example": "3000017/test.py"
},
"status": {
"type": "string",
"description": "Upload status",
"enum": [
"PENDING",
"COMPLETED",
"ABORTED"
]
},
"parts": {
"type": "array",
"description": "Uploads parts",
"items": {
"$ref": "#/components/schemas/UploadFilePart"
}
}
},
"x-tag": "upload"
},
"User": {
"required": [
"first_name",
"id",
"is_active",
"is_public",
"job_title",
"last_name",
"name",
"orcid_id",
"url_name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "User id",
"example": 1495682
},
"first_name": {
"type": "string",
"description": "First Name",
"example": "Doe"
},
"last_name": {
"type": "string",
"description": "Last Name",
"example": "John"
},
"name": {
"type": "string",
"description": "Full Name",
"example": "John Doe"
},
"is_active": {
"type": "boolean",
"description": "Account activity status",
"example": true
},
"url_name": {
"type": "string",
"description": "Name that appears in website url",
"example": "John_Doe"
},
"is_public": {
"type": "boolean",
"description": "Account public status",
"example": true
},
"job_title": {
"type": "string",
"description": "User Job title",
"example": "programmer"
},
"orcid_id": {
"type": "string",
"description": "Orcid associated to this User",
"example": "1234-5678-9123-1234"
}
},
"x-tag": "other"
},
"AltmetricInstitution": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Institution id",
"example": 1
},
"name": {
"type": "string",
"description": "Institution name",
"example": "My Institution"
},
"custom_domain": {
"type": "string",
"description": "Custom domain for the institution",
"example": "myinstitution.figshare.com",
"nullable": true
}
},
"x-tag": "altmetric"
}
},
"securitySchemes": {
"OAuth2": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://figshare.com/account/applications/authorize",
"tokenUrl": "https://api.figshare.com/v2/token",
"scopes": {
"all": "Grants all access"
}
}
}
}
},
"parameters": {},
"requestBodies": {},
"responses": {},
"headers": {},
"examples": {},
"links": {},
"callbacks": {}
},
"x-additional-descriptions": [
{
"title": "Upload files",
"position": "bottom",
"subsections": [
{
"title": "Steps to upload file",
"content": "description_upload_steps"
},
{
"title": "Uploads API",
"content": "description_upload_api"
},
{
"title": "Parts API",
"content": "description_upload_parts_api"
},
{
"title": "Example Upload on figshare",
"content": "description_upload_example"
},
{
"title": "Output of Script",
"content": "description_upload_output"
},
{
"title": "Upload Bash Script",
"content": "description_upload_bash"
},
{
"title": "Upload S3 File to Figshare",
"content": "description_upload_from_s3"
}
]
},
{
"title": "Search",
"position": "bottom",
"subsections": [
{
"title": "How to find data on figshare",
"content": "description_search_intro"
},
{
"title": "Search operators",
"content": "description_search_operators"
},
{
"title": "Searchable attributes",
"content": "description_search_attributes"
},
{
"title": "Quick search",
"content": "description_search_quick"
},
{
"title": "Advanced search",
"content": "description_search_advanced"
},
{
"title": "Combined field search",
"content": "description_search_combined"
},
{
"title": "Complex searches",
"content": "description_search_complex"
}
]
},
{
"title": "Stats",
"position": "bottom",
"subsections": [
{
"title": "Stats service",
"subsections": [
{
"title": "Intro",
"content": "description_stats_service_intro"
},
{
"title": "Authentication",
"content": "description_stats_service_auth"
},
{
"title": "Errors",
"content": "description_stats_service_errors"
},
{
"title": "Endpoints",
"content": "description_stats_service_endpoints"
}
]
},
{
"title": "Breakdown",
"subsections": [
{
"title": "Endpoints for retrieving a breakdown",
"content": "description_stats_breakdown_endpoints"
},
{
"title": "Authorization",
"content": "description_stats_breakdown_auth"
},
{
"title": "Endpoint format",
"content": "description_stats_breakdown_format"
},
{
"title": "Request parameters",
"content": "description_stats_breakdown_params"
},
{
"title": "Examples",
"content": "description_stats_breakdown_examples"
}
]
},
{
"title": "Timeline",
"subsections": [
{
"title": "Endpoints for retrieving a timeline",
"content": "description_stats_timeline_endpoints"
},
{
"title": "Authorization",
"content": "description_stats_timeline_auth"
},
{
"title": "Endpoint format",
"content": "description_stats_timeline_format"
},
{
"title": "Request parameters",
"content": "description_stats_timeline_params"
},
{
"title": "Examples",
"content": "description_stats_timeline_examples"
}
]
},
{
"title": "Tops",
"subsections": [
{
"title": "Endpoints for retrieving tops",
"content": "description_stats_tops_endpoints"
},
{
"title": "Authorization",
"content": "description_stats_tops_auth"
},
{
"title": "Endpoint format",
"content": "description_stats_tops_format"
},
{
"title": "Request parameters",
"content": "description_stats_tops_params"
},
{
"title": "Examples",
"content": "description_stats_tops_examples"
}
]
},
{
"title": "Totals",
"subsections": [
{
"title": "Endpoints for retrieving totals",
"content": "description_stats_totals_endpoints"
},
{
"title": "Authorization",
"content": "description_stats_totals_auth"
},
{
"title": "Endpoint format",
"content": "description_stats_totals_format"
},
{
"title": "Examples",
"content": "description_stats_totals_examples"
}
]
},
{
"title": "Count Articles",
"subsections": [
{
"title": "Endpoint for retrieving counts",
"content": "description_stats_count_endpoints"
},
{
"title": "Authorization",
"content": "description_stats_count_auth"
},
{
"title": "Endpoint format",
"content": "description_stats_count_format"
},
{
"title": "Example",
"content": "description_stats_count_examples"
}
]
}
]
},
{
"title": "OAI PMH",
"position": "bottom",
"subsections": [
{
"title": "OAI-PMH",
"content": "description_oai_pmh"
},
{
"title": "Base URL",
"content": "description_oai_baseurl"
},
{
"title": "Item equals Article",
"content": "description_oai_itemarticle"
},
{
"title": "Metadata formats",
"content": "description_oai_metadata"
},
{
"title": "Datestamps",
"content": "description_oai_datestamp"
},
{
"title": "Sets",
"content": "description_oai_sets"
},
{
"title": "Update schedule",
"content": "description_oai_update_schedule"
},
{
"title": "Pagination and Resumption Token Expiration",
"content": "description_oai_pagination"
},
{
"title": "Rate limit",
"content": "description_oai_ratelimit"
},
{
"title": "Future development",
"content": "description_oai_futuredev"
},
{
"title": "Some examples",
"content": "description_oai_someexamples"
}
]
},
{
"title": "HR Feed",
"position": "bottom",
"subsections": [
{
"title": "HR Feed Private Endpoint",
"content": "description_hrfeed_endpoint"
},
{
"title": "HR Feed examples",
"subsections": [
{
"title": "Python",
"content": "description_hrfeed_examples_python"
},
{
"title": "Java",
"content": "description_hrfeed_examples_java"
},
{
"title": "C Sharp",
"content": "description_hrfeed_examples_csharp"
},
{
"title": "Curl",
"content": "description_hrfeed_examples_curl"
}
]
},
{
"title": "Response",
"content": "description_hrfeed_response"
},
{
"title": "Errors",
"content": "description_hrfeed_errors"
},
{
"title": "Notes",
"content": "description_hrfeed_notes"
}
]
},
{
"title": "Custom Fields",
"position": "bottom",
"subsections": [
{
"title": "Custom Fields Private Endpoints",
"content": "description_custom_fields_endpoint"
},
{
"title": "Custom Fields examples",
"subsections": [
{
"title": "Python",
"content": "description_custom_fields_examples_python"
},
{
"title": "Java",
"content": "description_custom_fields_examples_java"
},
{
"title": "C Sharp",
"content": "description_custom_fields_examples_csharp"
},
{
"title": "Curl",
"content": "description_custom_fields_examples_curl"
}
]
},
{
"title": "Response",
"content": "description_custom_fields_response"
},
{
"title": "Errors",
"content": "description_custom_fields_errors"
},
{
"title": "Notes",
"content": "description_custom_fields_notes"
}
]
},
{
"title": "figshare Documentation",
"position": "top",
"subsections": [
{
"title": "figshare Documentation",
"content": "description_intro"
},
{
"title": "OAuth",
"subsections": [
{
"title": "Intro",
"content": "description_oauth_intro"
},
{
"title": "Quick guide",
"content": "description_oauth_quick"
},
{
"title": "Scope",
"content": "description_oauth_scope"
},
{
"title": "Grant Types",
"content": "description_oauth_grant"
}
]
},
{
"title": "API description",
"subsections": [
{
"title": "Feature list",
"content": "description_api_features"
},
{
"title": "Sending parameters",
"content": "description_api_parameters"
},
{
"title": "Resource representations",
"content": "description_api_resourcerepresentation"
},
{
"title": "Authentication",
"content": "description_api_auth"
},
{
"title": "Errors",
"content": "description_api_errors"
},
{
"title": "Searching filtering and pagination",
"content": "description_api_search"
},
{
"title": "Rate limiting",
"content": "description_api_ratelimit"
},
{
"title": "Conditional requests",
"content": "description_api_requests"
},
{
"title": "CORS policy",
"content": "description_api_cors"
},
{
"title": "Impersonation",
"content": "description_api_impersonation"
}
]
}
]
}
],
"x-original-swagger-version": "2.0"
}