{
  "opencollection": "1.0.0",
  "info": {
    "name": "Dataverse Access milestone API",
    "version": "6.9"
  },
  "items": [
    {
      "info": {
        "name": "milestone",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all milestones",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned milestones per request."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset for the returned list. 0 or null value is from the start"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order of the list, must be a value from /milestones/orderings"
              }
            ]
          },
          "docs": "Lists all milestones in the Pure instance. If you need to filter the milestones returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create milestone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/milestones",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create milestone"
        },
        {
          "info": {
            "name": "A list of allowed classifications for the category property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/allowed-categories"
          },
          "docs": "Get a list of classifications that can be used when submitting a category."
        },
        {
          "info": {
            "name": "A list of allowed completion states",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/allowed-completion-states"
          },
          "docs": "Get a list of allowed completion state types that can be used for the 'completionState' attribute of milestones"
        },
        {
          "info": {
            "name": "A list of allowed document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/allowed-document-types"
          },
          "docs": "Get a list of allowed license types that can be used for the 'documents.type' attribute of milestones"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed milestone states",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/allowed-milestone-states"
          },
          "docs": "Get a list of allowed milestone state types that can be used for the 'milestoneState' attribute of milestones"
        },
        {
          "info": {
            "name": "A list of allowed academic roles for milestones which have a related application",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/application/allowed-academic-roles"
          },
          "docs": "Get a list of allowed academic role types that can be used for the 'academicRole' attribute of milestones"
        },
        {
          "info": {
            "name": "A list of allowed administrative roles for milestones which have a related application",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/application/allowed-administrative-roles"
          },
          "docs": "Get a list of allowed administrative role types that can be used for the 'administrativeRole' attribute of milestones which have a related application"
        },
        {
          "info": {
            "name": "A list of allowed academic roles for milestones which have a related award",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/award/allowed-academic-roles"
          },
          "docs": "Get a list of allowed academic role types that can be used for the 'academicRole' attribute of milestones"
        },
        {
          "info": {
            "name": "A list of allowed administrative roles for milestones which have a related award",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/award/allowed-administrative-roles"
          },
          "docs": "Get a list of allowed administrative role types that can be used for the 'administrativeRole' attribute of milestones which have a related award"
        },
        {
          "info": {
            "name": "A list of allowed academic roles for milestones which have a related contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/contract/allowed-academic-roles"
          },
          "docs": "Get a list of allowed academic role types that can be used for the 'academicRole' attribute of milestones"
        },
        {
          "info": {
            "name": "A list of allowed administrative roles for milestones which have a related contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/contract/allowed-administrative-roles"
          },
          "docs": "Get a list of allowed administrative role types that can be used for the 'administrativeRole' attribute of milestones which have a related contract"
        },
        {
          "info": {
            "name": "A list of allowed academic roles for milestones which have a related ethical review",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/ethical-review/allowed-academic-roles"
          },
          "docs": "Get a list of allowed academic role types that can be used for the 'academicRole' attribute of milestones"
        },
        {
          "info": {
            "name": "A list of allowed administrative roles for milestones which have a related ethical review",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/ethical-review/allowed-administrative-roles"
          },
          "docs": "Get a list of allowed administrative role types that can be used for the 'administrativeRole' attribute of milestones which have a related ethical review"
        },
        {
          "info": {
            "name": "Upload file for a specific milestone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/milestones/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the milestone"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/orderings"
          },
          "docs": "Lists all orderings available to the milestones endpoint. These values can be used by the order parameter when listing milestones."
        },
        {
          "info": {
            "name": "A list of allowed academic roles for milestones which have a related project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/project/allowed-academic-roles"
          },
          "docs": "Get a list of allowed academic role types that can be used for the 'academicRole' attribute of milestones"
        },
        {
          "info": {
            "name": "A list of allowed administrative roles for milestones which have a related project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/project/allowed-administrative-roles"
          },
          "docs": "Get a list of allowed administrative role types that can be used for the 'administrativeRole' attribute of milestones which have a related project"
        },
        {
          "info": {
            "name": "Query operation for milestones",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dataverse.nl/milestones/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists milestones in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options."
        },
        {
          "info": {
            "name": "Get milestone",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired milestone"
              }
            ]
          },
          "docs": "Get milestone with specific UUID."
        },
        {
          "info": {
            "name": "Update milestone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/milestones/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the milestone to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update milestone with specific UUID."
        },
        {
          "info": {
            "name": "Delete milestone",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://dataverse.nl/milestones/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the milestone"
              }
            ]
          },
          "docs": "Delete milestone with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dataverse.nl/milestones/:uuid/actions/lock",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the content to lock"
              }
            ]
          },
          "docs": "Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API."
        },
        {
          "info": {
            "name": "Unlock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dataverse.nl/milestones/:uuid/actions/unlock",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the content to unlock"
              }
            ]
          },
          "docs": "Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API."
        },
        {
          "info": {
            "name": "Lists all dependents to a milestone",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the milestone"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "DEPRECATED - Parameter has no effect."
              }
            ]
          },
          "docs": "Lists all dependents to a milestone with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. "
        },
        {
          "info": {
            "name": "Get file from the milestone",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/milestones/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the milestone"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "File id "
              }
            ]
          },
          "docs": "Get file from the milestone"
        }
      ]
    }
  ],
  "bundled": true
}