{
  "opencollection": "1.0.0",
  "info": {
    "name": "Dataverse Access authorCollaboration API",
    "version": "6.9"
  },
  "items": [
    {
      "info": {
        "name": "authorCollaboration",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all  author collaborations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/author-collaborations",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned  author collaborations 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 /author-collaborations/orderings"
              }
            ]
          },
          "docs": "Lists all  author collaborations in the Pure instance. If you need to filter the author collaborations returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create author collaboration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/author-collaborations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create author collaboration"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/author-collaborations/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed workflow steps",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/author-collaborations/allowed-workflow-steps"
          },
          "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of author collaboration"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/author-collaborations/orderings"
          },
          "docs": "Lists all orderings available to the author collaboration endpoint. These values can be used by the order parameter when listing author collaborations."
        },
        {
          "info": {
            "name": "Query operation for author-collaborations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dataverse.nl/author-collaborations/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists author-collaborations 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 author collaboration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/author-collaborations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired author collaboration"
              }
            ]
          },
          "docs": "Get author collaboration with specific UUID."
        },
        {
          "info": {
            "name": "Update author collaboration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/author-collaborations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the author collaboration to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update author collaboration with specific UUID."
        },
        {
          "info": {
            "name": "Delete author collaboration",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://dataverse.nl/author-collaborations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the author collaboration"
              }
            ]
          },
          "docs": "Delete author collaboration with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dataverse.nl/author-collaborations/: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/author-collaborations/: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 notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dataverse.nl/author-collaborations/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the author collaboration to get notes for"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned notes per request"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset for the returned list. 0 or null value is from the start"
              }
            ]
          },
          "docs": "Lists notes associated with a author collaboration ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dataverse.nl/author-collaborations/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the author collaboration to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with a author collaboration"
        }
      ]
    }
  ],
  "bundled": true
}