/datasets/{id}/editions/{edition}

GET

The edition contains a link to all versions

Parameters

Name Type Description
edition path An edition of a dataset
id path Id that represents a dataset

Responses

200: A json object containing an edition

Example value
{
  "type": "object",
  "properties": {
    "edition": {
      "description": "The edition of the dataset",
      "type": "string",
      "readOnly": true,
      "example": "2017"
    },
    "id": {
      "description": "An unique id for a dataset edition",
      "type": "string",
      "readOnly": true
    },
    "links": {
      "description": "A list of links related to this resource",
      "type": "object",
      "properties": {
        "dataset": {
          "description": "An object containing the dataset id and link",
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to the parent dataset for this resource",
              "type": "string",
              "example": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC"
            },
            "id": {
              "description": "The unique id for the dataset of this version",
              "type": "string"
            }
          },
          "readOnly": true
        },
        "latest_version": {
          "description": "An object containing the latest version id and link",
          "type": "object",
          "properties": {
            "href": {
              "description": "A link to the latest version and edition of the dataset",
              "type": "string",
              "example": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/versions/2"
            },
            "id": {
              "description": "The unique id for the latest version of a dataset",
              "type": "string"
            }
          },
          "readOnly": true
        },
        "self": {
          "description": "A link to this resource",
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to this resource",
              "type": "string"
            }
          },
          "readOnly": true
        },
        "versions": {
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to all versions dor an edition of a dataset",
              "type": "string",
              "example": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/edition/2017/versions"
            }
          }
        }
      },
      "readOnly": true
    },
    "state": {
      "description": "The state of the resource, can only be one of the following:\n  * created\n  * completed (instances only)\n  * failed (instances only)\n  * edition-confirmed (instances and versions only)\n  * associated (not editions)\n  * published\n",
      "type": "string"
    }
  }
}

400: Invalid request, dataset id was incorrect

Example value
null

404: No edition of a dataset was found using the id and edition provided

Example value
null

500: Failed to process the request due to an internal error

Example value
null