{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coscine Web Admin Pid API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Pid",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves the Persistent Identifier (PID) for a given prefix and suffix.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://coscine.rwth-aachen.de/coscine/api/v2/pids/:prefix/:suffix",
            "params": [
              {
                "name": "prefix",
                "value": "",
                "type": "path",
                "description": "The PID prefix. Limited to the values provided by the API."
              },
              {
                "name": "suffix",
                "value": "",
                "type": "path",
                "description": "The PID suffix of a project or a resource, represented as a GUID."
              }
            ]
          },
          "docs": "Retrieves the Persistent Identifier (PID) for a given prefix and suffix."
        },
        {
          "info": {
            "name": "Sends an inquiry to the owner of the given PID.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://coscine.rwth-aachen.de/coscine/api/v2/pids/:prefix/:suffix/requests",
            "params": [
              {
                "name": "prefix",
                "value": "",
                "type": "path",
                "description": "The PID prefix of a project or a resource to validate"
              },
              {
                "name": "suffix",
                "value": "",
                "type": "path",
                "description": "The PID body of a project or a resource to validate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sends an inquiry to the owner of the given PID."
        },
        {
          "info": {
            "name": "Retrieves all PIDs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://coscine.rwth-aachen.de/coscine/api/v2/pids",
            "params": [
              {
                "name": "IncludeProjects",
                "value": "",
                "type": "query",
                "description": "Gets or sets a value indicating whether to include projects when retrieving pid information."
              },
              {
                "name": "IncludeResources",
                "value": "",
                "type": "query",
                "description": "Gets or sets a value indicating whether to include resources when retrieving pid information."
              },
              {
                "name": "IncludeDeleted",
                "value": "",
                "type": "query",
                "description": "Gets or sets a value indicating whether to include deleted pid information."
              },
              {
                "name": "PageNumber",
                "value": "",
                "type": "query",
                "description": "Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1."
              },
              {
                "name": "PageSize",
                "value": "",
                "type": "query",
                "description": "Gets or sets the desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10."
              },
              {
                "name": "OrderBy",
                "value": "",
                "type": "query",
                "description": "Gets or sets the field name used for ordering the results.\r\nThe order is constructed by an order string.\r\nUse the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.\r\nCan be used like this: \"propertyA asc, propertyB desc\"."
              }
            ]
          },
          "docs": "<p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>"
        },
        {
          "info": {
            "name": "Responds with the HTTP methods allowed for the endpoint.",
            "type": "http"
          },
          "http": {
            "method": "OPTIONS",
            "url": "https://coscine.rwth-aachen.de/coscine/api/v2/pids"
          },
          "docs": "Responds with the HTTP methods allowed for the endpoint."
        }
      ]
    }
  ],
  "bundled": true
}