{
  "opencollection": "1.0.0",
  "info": {
    "name": "PHAIDRA datastream relationships API",
    "version": "3.0"
  },
  "items": [
    {
      "info": {
        "name": "relationships",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get pids of collection members.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.phaidra.univie.ac.at/api/collection/:pid/members",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "pid"
              }
            ]
          },
          "docs": "Returns the pids of the members of a collection. "
        },
        {
          "info": {
            "name": "Returns descendants of collection.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.phaidra.univie.ac.at/api/collection/:pid/descendants",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "collection pid"
              }
            ]
          },
          "docs": "Get descendants."
        },
        {
          "info": {
            "name": "Remove collection members.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.phaidra.univie.ac.at/api/collection/:pid/members/remove",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "pid"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "metadata",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Remove collection members."
        },
        {
          "info": {
            "name": "Add collection members.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.phaidra.univie.ac.at/api/collection/:pid/members/add",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "collection pid"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "metadata",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Add collection members."
        },
        {
          "info": {
            "name": "Orders collection members",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.phaidra.univie.ac.at/api/collection/:pid/members/order",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "collection pid"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "metadata",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Orders collection members"
        },
        {
          "info": {
            "name": "Changes order of single member.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.phaidra.univie.ac.at/api/collection/:pid/members/:itempid/order/:position",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "collection pid"
              },
              {
                "name": "itempid",
                "value": "",
                "type": "path",
                "description": "member pid"
              },
              {
                "name": "position",
                "value": "",
                "type": "path",
                "description": "position"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Changes order of a single collection member."
        },
        {
          "info": {
            "name": "Orders members of a container.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.phaidra.univie.ac.at/api/container/:pid/members/order",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "container pid"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "metadata",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Orders members of a container."
        },
        {
          "info": {
            "name": "Changes order of single member.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.phaidra.univie.ac.at/api/container/:pid/members/:itempid/order/:position",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "container pid"
              },
              {
                "name": "itempid",
                "value": "",
                "type": "path",
                "description": "member pid"
              },
              {
                "name": "position",
                "value": "",
                "type": "path",
                "description": "position"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Changes order of a single container member."
        },
        {
          "info": {
            "name": "Get related objects.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.phaidra.univie.ac.at/api/object/:pid/related",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "the requested object id"
              },
              {
                "name": "relation",
                "value": "",
                "type": "query",
                "description": "Specifies the relation which should be returned, see [relations](https://github.com/phaidra/phaidra-api/wiki/Relations)"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "nr of entries to skip (paging)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "nr of entries to return (paging)"
              },
              {
                "name": "right",
                "value": "",
                "type": "query",
                "description": "searches for the relation in opposite direction (e.g. for `hasCollectionMember`: 0 will return a list of objects which are members of this object/collection, 1 will return a list of objects/collections where the object is a member)"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "fields from the index which should be returned. Only works for `fields=dc.description`. The title field is returned by default. Preferred title and description fields are the English ones."
              }
            ]
          },
          "docs": "This method returns all objects which are in some relation to the object specified in URL."
        },
        {
          "info": {
            "name": "Add a relationship.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.phaidra.univie.ac.at/api/object/:pid/relationship/add",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "object id"
              },
              {
                "name": "predicate",
                "value": "",
                "type": "query",
                "description": "the relationship [list of supported relationships](https://github.com/phaidra/phaidra-api/wiki/Relations)"
              },
              {
                "name": "object",
                "value": "",
                "type": "query",
                "description": "the model of the related object in the repository. A list of possible content models is found [here](https://github.com/phaidra/phaidra-api/wiki/Creating-a-simple-object)"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Add a triple. It is then available in the triplestore and indexed automatically. Adding some system relationships (like hasModel) might be restricted. See the [list of supported relationships](https://github.com/phaidra/phaidra-api/wiki/Relations)."
        },
        {
          "info": {
            "name": "Remove a relationship from RELS-EXT.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.phaidra.univie.ac.at/api/object/:pid/relationship/remove",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "path",
                "description": "the requested object id"
              },
              {
                "name": "predicate",
                "value": "",
                "type": "query",
                "description": "the relationship [list of supported relationships](https://github.com/phaidra/phaidra-api/wiki/Relations)"
              },
              {
                "name": "object",
                "value": "",
                "type": "query",
                "description": "the model of the related object in the repository. A list of possible content models is found [here](https://github.com/phaidra/phaidra-api/wiki/Creating-a-simple-object)"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Remove a relationship from the RELS-EXT datastream. Removing some [system relationships](https://github.com/phaidra/phaidra-api/wiki/Relations) (like hasModel) might be restricted."
        }
      ]
    }
  ],
  "bundled": true
}