{
  "opencollection": "1.0.0",
  "info": {
    "name": "La Trobe University OPAL (Figshare) Public articles API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "articles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Public Articles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/articles",
            "headers": [
              {
                "name": "X-Cursor",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Used for pagination with page_size"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results included on a page. Used for pagination with page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results included on a page. Used for pagination with query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Where to start the listing (the offset of the first result). Used for pagination with limit"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The field by which to order. Default varies by endpoint/resource."
              },
              {
                "name": "order_direction",
                "value": "",
                "type": "query"
              },
              {
                "name": "institution",
                "value": "",
                "type": "query",
                "description": "only return articles from this institution"
              },
              {
                "name": "published_since",
                "value": "",
                "type": "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"
              },
              {
                "name": "modified_since",
                "value": "",
                "type": "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"
              },
              {
                "name": "group",
                "value": "",
                "type": "query",
                "description": "only return articles from this group"
              },
              {
                "name": "resource_doi",
                "value": "",
                "type": "query",
                "description": "Deprecated by related materials. Only return articles with this resource_doi"
              },
              {
                "name": "item_type",
                "value": "",
                "type": "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"
              },
              {
                "name": "doi",
                "value": "",
                "type": "query",
                "description": "only return articles with this doi"
              },
              {
                "name": "handle",
                "value": "",
                "type": "query",
                "description": "only return articles with this handle"
              }
            ]
          },
          "docs": "Returns a list of public articles"
        },
        {
          "info": {
            "name": "Public Articles Search",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/articles/search",
            "headers": [
              {
                "name": "X-Cursor",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns a list of public articles, filtered by the search parameters"
        },
        {
          "info": {
            "name": "View article details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/articles/:article_id",
            "params": [
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Article Unique identifier"
              }
            ]
          },
          "docs": "View an article"
        },
        {
          "info": {
            "name": "List article files",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/articles/:article_id/files",
            "params": [
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Article Unique identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Used for pagination with page_size"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results included on a page. Used for pagination with page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results included on a page. Used for pagination with query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Where to start the listing (the offset of the first result). Used for pagination with limit"
              }
            ]
          },
          "docs": "Files list for article"
        },
        {
          "info": {
            "name": "Article file details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/articles/:article_id/files/:file_id",
            "params": [
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Article Unique identifier"
              },
              {
                "name": "file_id",
                "value": "",
                "type": "path",
                "description": "File Unique identifier"
              }
            ]
          },
          "docs": "File by id"
        },
        {
          "info": {
            "name": "List article versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/articles/:article_id/versions",
            "params": [
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Article Unique identifier"
              }
            ]
          },
          "docs": "List public article versions"
        },
        {
          "info": {
            "name": "Article details for version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/articles/:article_id/versions/:version_id",
            "params": [
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Article Unique identifier"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path",
                "description": "Article Version Number"
              }
            ]
          },
          "docs": "Article with specified version"
        }
      ]
    }
  ],
  "bundled": true
}