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.
643 matches
100 actions
Figshare
100 actions
- Account Article ReportGETv1.0.0
- Add article authorsPOSTv1.0.0
- Add article categoriesPOSTv1.0.0
- Add collection articlesPOSTv1.0.0
- Add collection authorsPOSTv1.0.0
- Add collection categoriesPOSTv1.0.0
- Article confidentiality detailsGETv1.0.0
- Article detailsGETv1.0.0
- Article Embargo DetailsGETv1.0.0
- Article file detailsGETv1.0.0
- Author detailsGETv1.0.0
- Collection detailsGETv1.0.0
- Collection detailsGETv1.0.0
- Create collectionPOSTv1.0.0
- Create collection private linkPOSTv1.0.0
- Create new ArticlePOSTv1.0.0
- Create new Institution AccountPOSTv1.0.0
- Create private linkPOSTv1.0.0
- Create projectPOSTv1.0.0
- Create project articlePOSTv1.0.0
- Create project notePOSTv1.0.0
- Delete articleDELETEv1.0.0
- Delete article authorDELETEv1.0.0
- Delete article categoryDELETEv1.0.0
- Delete article confidentialityDELETEv1.0.0
- Delete Article EmbargoDELETEv1.0.0
- Delete collectionDELETEv1.0.0
- Delete collection articleDELETEv1.0.0
- Delete collection authorDELETEv1.0.0
- Delete collection categoryDELETEv1.0.0
- Delete Institution Account Group RoleDELETEv1.0.0
- Delete projectDELETEv1.0.0
- Delete project articleDELETEv1.0.0
- Delete project noteDELETEv1.0.0
- Initiate a new ReportPOSTv1.0.0
- Institution Curation ReviewGETv1.0.0
- Institution Curation Review CommentsGETv1.0.0
- Institution Curation ReviewsGETv1.0.0
- Item TypesGETv1.0.0
- List article authorsGETv1.0.0
- List article categoriesGETv1.0.0
- List article filesGETv1.0.0
- List article filesGETv1.0.0
- List collection articlesGETv1.0.0
- List collection authorsGETv1.0.0
- List collection categoriesGETv1.0.0
- List collection private linksGETv1.0.0
- List Institution Account Group RolesGETv1.0.0
- List private linksGETv1.0.0
- List project articlesGETv1.0.0
- List project collaboratorsGETv1.0.0
- List project notesGETv1.0.0
- POST Institution Curation Review CommentPOSTv1.0.0
- Private Account CategoriesGETv1.0.0
- Private Account informationGETv1.0.0
- Private Account Institution embargo optionsGETv1.0.0
- Private account institution group custom fieldsGETv1.0.0
- Private Account Institution Group Embargo OptionsGETv1.0.0
- Private Account Institution GroupsGETv1.0.0
- Private Account Institution RolesGETv1.0.0
- Private Account Institution UserGETv1.0.0
- Private Account InstitutionsGETv1.0.0
- Private Account LicensesGETv1.0.0
- Private Article PublishPOSTv1.0.0
- Private Article Reserve DOIPOSTv1.0.0
- Private Article Reserve HandlePOSTv1.0.0
- Private Article ResourcePOSTv1.0.0
- Private ArticlesGETv1.0.0
- Private Articles searchPOSTv1.0.0
- Private Collection PublishPOSTv1.0.0
- Private Collection Reserve DOIPOSTv1.0.0
- Private Collection Reserve HandlePOSTv1.0.0
- Private Collection ResourcePOSTv1.0.0
- Private Collections ListGETv1.0.0
- Project article detailsGETv1.0.0
- Project article file detailsGETv1.0.0
- Project article list filesGETv1.0.0
- Project note detailsGETv1.0.0
- Public Articles SearchPOSTv1.0.0
- Public CategoriesGETv1.0.0
- Public Collection ArticlesGETv1.0.0
- Public Collections SearchPOSTv1.0.0
- Public LicensesGETv1.0.0
- Public LicensesGETv1.0.0
- Public ProjectGETv1.0.0
- Public Project ArticlesGETv1.0.0
- Search AuthorsPOSTv1.0.0
- Search FundingPOSTv1.0.0
- Single FileGETv1.0.0
- Update articlePUTv1.0.0
- Update article confidentialityPUTv1.0.0
- Update Article EmbargoPUTv1.0.0
- Update collectionPUTv1.0.0
- Update collection private linkPUTv1.0.0
- Update Institution AccountPUTv1.0.0
- Update private linkPUTv1.0.0
- Update projectPUTv1.0.0
- Update project notePUTv1.0.0
- View article detailsGETv1.0.0
- View project detailsGETv1.0.0
Other/Figshare
Update Article Embargo
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
{
"type": "object",
"required": [
"embargo_date",
"embargo_type",
"is_embargoed"
],
"properties": {
"embargo_date": {
"type": "string",
"description": "Date when the embargo expires and the article gets published, '0' value will set up permanent embargo"
},
"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.",
"items": {
"type": "object"
}
},
"embargo_reason": {
"type": "string",
"description": "Reason for setting embargo"
},
"embargo_title": {
"type": "string",
"description": "Title for embargo"
},
"embargo_type": {
"type": "string",
"description": "Embargo can be enabled at the article or the file level. Possible values: article, file",
"enum": [
"article",
"file"
]
},
"is_embargoed": {
"type": "boolean",
"description": "Embargo status"
}
}
}Output
- 1
- 2
- 3
- 4
{
"type": "object",
"additionalProperties": true
}