FIfigshare
articles

Public Article Embargo for article version

Changed on

Embargo for article version

get/articles/{article_id}/versions/{version_id}/embargo

Request

Path parameters

article_idinteger required

Article Unique identifier

version_idinteger required

Version Number

Response

OK. Embargo representation

is_embargoedboolean required

True if embargoed

embargo_datestring

Date when the embargo expires and the article gets published, null if not embargoed

embargo_type'article' | 'file'

Embargo level. Possible values: article, file

embargo_titlestring required

Title for embargo

embargo_reasonstring required

Reason for embargo

embargo_optionsobject[] required

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 response

{
  "is_embargoed": true,
  "embargo_date": "2018-05-22T04:04:04",
  "embargo_type": "file",
  "embargo_title": "File(s) under embargo",
  "embargo_options": [
    {
      "id": 13,
      "type": "ip_range",
      "group_ids": [],
      "ip_name": "bacau"
    },
    {
      "id": 12,
      "type": "logged_in",
      "ip_name": "",
      "group_ids": [
        550,
        9448
      ]
    }
  ]
}

Changes

  • 7dd8ffee0fafRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status