{
  "opencollection": "1.0.0",
  "info": {
    "name": "Girder REST API (Emory Digital Slide Archive) annotation system API",
    "version": "3.2.14"
  },
  "items": [
    {
      "info": {
        "name": "system",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all access flags available in the system.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/access_flag"
          },
          "docs": "List all access flags available in the system."
        },
        {
          "info": {
            "name": "Report the current system status.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/check",
            "params": [
              {
                "name": "mode",
                "value": "",
                "type": "query",
                "description": "Select details to return. \"quick\" are the details that can be answered without much load on the system. \"slow\" also includes some resource-intensive queries."
              }
            ]
          },
          "docs": "Must be a system administrator to call this with any mode other than basic."
        },
        {
          "info": {
            "name": "Perform a variety of system checks to verify that all is well.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://computablebrain.emory.edu/api/v1/system/check",
            "params": [
              {
                "name": "progress",
                "value": "",
                "type": "query",
                "description": "Whether to record progress on this task."
              }
            ]
          },
          "docs": "Must be a system administrator to call this.  This verifies and corrects some issues, such as incorrect folder sizes."
        },
        {
          "info": {
            "name": "Get the value of a system configuration option.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/configuration",
            "params": [
              {
                "name": "section",
                "value": "",
                "type": "query",
                "description": "The section identifying the configuration option."
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "The key identifying the configuration option."
              }
            ]
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Test connection status to a LDAP server.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/ldap_server/status",
            "params": [
              {
                "name": "uri",
                "value": "",
                "type": "query",
                "description": "The URI of the server."
              },
              {
                "name": "bindName",
                "value": "",
                "type": "query",
                "description": "The LDAP identity to bind with."
              },
              {
                "name": "password",
                "value": "",
                "type": "query",
                "description": "Password to bind with."
              }
            ]
          },
          "docs": "You must be an administrator to call this."
        },
        {
          "info": {
            "name": "Show the most recent contents of the server logs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/log",
            "params": [
              {
                "name": "bytes",
                "value": "",
                "type": "query",
                "description": "Controls how many bytes (from the end of the log) to show. Pass 0 to show the whole log."
              },
              {
                "name": "log",
                "value": "",
                "type": "query",
                "description": "Which log to tail."
              }
            ]
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Get the current log level.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/log/level"
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Set the current log level.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://computablebrain.emory.edu/api/v1/system/log/level",
            "params": [
              {
                "name": "level",
                "value": "",
                "type": "query",
                "description": "The new level to set."
              }
            ]
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Get the lists of all available and all loaded plugins.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/plugins"
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Restart the Girder REST server.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://computablebrain.emory.edu/api/v1/system/restart"
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Get the value of a system setting, or a list of them.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/setting",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "The key identifying this setting."
              },
              {
                "name": "list",
                "value": "",
                "type": "query",
                "description": "A JSON list of keys representing a set of settings to return."
              }
            ]
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Set the value for a system setting, or a list of them.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://computablebrain.emory.edu/api/v1/system/setting",
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "key",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "value",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "list",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Must be a system administrator to call this. If the value passed is a valid JSON object, it will be parsed and stored as an object."
        },
        {
          "info": {
            "name": "Unset the value for a system setting.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://computablebrain.emory.edu/api/v1/system/setting",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "The key identifying the setting to unset."
              }
            ]
          },
          "docs": "Must be a system administrator to call this. This is used to explicitly restore a setting to its default value."
        },
        {
          "info": {
            "name": "Get access of content creation policy.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/setting/collection_creation_policy/access"
          },
          "docs": "Get result in the same structure as the access endpoints of collection, file, and group"
        },
        {
          "info": {
            "name": "Get the value of a system setting, or a list of them.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/setting/default",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "The key identifying this setting."
              },
              {
                "name": "list",
                "value": "",
                "type": "query",
                "description": "A JSON list of keys representing a set of settings to return."
              },
              {
                "name": "default",
                "value": "",
                "type": "query",
                "description": "If \"none\", return a null value if a setting is currently the default value. If \"default\", return the default value of the setting(s)."
              }
            ]
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Get a list of uploads that have not been finished.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/uploads",
            "params": [
              {
                "name": "uploadId",
                "value": "",
                "type": "query",
                "description": "List only a specific upload."
              },
              {
                "name": "userId",
                "value": "",
                "type": "query",
                "description": "Restrict listing uploads to those started by a specific user."
              },
              {
                "name": "parentId",
                "value": "",
                "type": "query",
                "description": "Restrict listing uploads to those within a specific folder or item."
              },
              {
                "name": "assetstoreId",
                "value": "",
                "type": "query",
                "description": "Restrict listing uploads within a specific assetstore."
              },
              {
                "name": "minimumAge",
                "value": "",
                "type": "query",
                "description": "Restrict listing uploads to those that are at least this many days old."
              },
              {
                "name": "includeUntracked",
                "value": "",
                "type": "query",
                "description": "Some assetstores can have partial uploads that are no longer in the Girder database.  If this is True, include all of them (only filtered by assetstoreId) in the result list."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Result set size limit."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset into result set."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Field to sort the result set by."
              },
              {
                "name": "sortdir",
                "value": "",
                "type": "query",
                "description": "Sort order: 1 for ascending, -1 for descending."
              }
            ]
          },
          "docs": "Must be a system administrator to call this."
        },
        {
          "info": {
            "name": "Discard uploads that have not been finished.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://computablebrain.emory.edu/api/v1/system/uploads",
            "params": [
              {
                "name": "uploadId",
                "value": "",
                "type": "query",
                "description": "Clear only a specific upload."
              },
              {
                "name": "userId",
                "value": "",
                "type": "query",
                "description": "Restrict clearing uploads to those started by a specific user."
              },
              {
                "name": "parentId",
                "value": "",
                "type": "query",
                "description": "Restrict clearing uploads to those within a specific folder or item."
              },
              {
                "name": "assetstoreId",
                "value": "",
                "type": "query",
                "description": "Restrict clearing uploads within a specific assetstore."
              },
              {
                "name": "minimumAge",
                "value": "",
                "type": "query",
                "description": "Restrict clearing uploads to those that are at least this many days old."
              },
              {
                "name": "includeUntracked",
                "value": "",
                "type": "query",
                "description": "Some assetstores can have partial uploads that are no longer in the Girder database.  If this is True, remove all of them (only filtered by assetstoreId)."
              }
            ]
          },
          "docs": "Must be a system administrator to call this. This frees resources that were allocated for the uploads and clears the uploads from database."
        },
        {
          "info": {
            "name": "Get the version information for this server.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/system/version"
          },
          "docs": "Get the version information for this server."
        }
      ]
    }
  ],
  "bundled": true
}