Public Collections Search

v1.0.0

Returns a list of public collections

Input

{
  "type": "object",
  "properties": {
    "X-Cursor": {
      "type": "string",
      "format": "uuid"
    },
    "doi": {
      "type": "string",
      "description": "Only return collections with this doi"
    },
    "handle": {
      "type": "string",
      "description": "Only return collections with this handle"
    },
    "order": {
      "type": "string",
      "description": "The field by which to order.",
      "enum": [
        "published_date",
        "modified_date",
        "views",
        "shares",
        "cites"
      ]
    },
    "resource_doi": {
      "type": "string",
      "description": "Only return collections with this resource_doi"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "title",
      "doi",
      "handle",
      "url",
      "timeline",
      "published_date"
    ],
    "properties": {
      "doi": {
        "type": "string",
        "description": "Collection DOI"
      },
      "handle": {
        "type": "string",
        "description": "Collection Handle"
      },
      "id": {
        "type": "integer",
        "format": "int64",
        "description": "Collection id"
      },
      "published_date": {
        "type": "string",
        "description": "Date when collection was published "
      },
      "timeline": {
        "type": "object",
        "required": [
          "posted",
          "submission",
          "revision",
          "firstOnline",
          "publisherPublication",
          "publisherAcceptance"
        ],
        "properties": {
          "posted": {
            "type": "string",
            "description": "Posted date"
          },
          "revision": {
            "type": "string",
            "description": "Revision date from curation (if curated)"
          },
          "submission": {
            "type": "string",
            "description": "Submission date in curation (if curated)"
          }
        }
      },
      "title": {
        "type": "string",
        "description": "Collection title"
      },
      "url": {
        "type": "string",
        "description": "Api endpoint"
      }
    }
  }
}