{
  "opencollection": "1.0.0",
  "info": {
    "name": "Girder REST API (Emory Digital Slide Archive) annotation group API",
    "version": "3.2.14"
  },
  "items": [
    {
      "info": {
        "name": "group",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search for groups or list all groups.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/group",
            "params": [
              {
                "name": "text",
                "value": "",
                "type": "query",
                "description": "Pass this to perform a full-text search for groups."
              },
              {
                "name": "exact",
                "value": "",
                "type": "query",
                "description": "If true, only return exact name matches. This is case sensitive."
              },
              {
                "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": "Search for groups or list all groups."
        },
        {
          "info": {
            "name": "Create a new group.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://computablebrain.emory.edu/api/v1/group",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Unique name for the group."
              },
              {
                "name": "description",
                "value": "",
                "type": "query",
                "description": "Description of the group."
              },
              {
                "name": "public",
                "value": "",
                "type": "query",
                "description": "Whether the group should be publicly visible."
              }
            ]
          },
          "docs": "Must be logged in."
        },
        {
          "info": {
            "name": "Get a group by ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ]
          },
          "docs": "Get a group by ID."
        },
        {
          "info": {
            "name": "Update a group by ID.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name to set on the group."
              },
              {
                "name": "description",
                "value": "",
                "type": "query",
                "description": "Description for the group."
              },
              {
                "name": "public",
                "value": "",
                "type": "query",
                "description": "Whether the group should be publicly visible"
              },
              {
                "name": "addAllowed",
                "value": "",
                "type": "query",
                "description": "Can admins or moderators directly add members to this group?  Only system administrators are allowed to set this field"
              }
            ]
          },
          "docs": "Update a group by ID."
        },
        {
          "info": {
            "name": "Delete a group by ID.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ]
          },
          "docs": "Delete a group by ID."
        },
        {
          "info": {
            "name": "Get the access control list for a group.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/access",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ]
          },
          "docs": "Get the access control list for a group."
        },
        {
          "info": {
            "name": "Promote a member to be an administrator of the group.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/admin",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "userId",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Promote a member to be an administrator of the group."
        },
        {
          "info": {
            "name": "Demote a user to a normal group member.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/admin",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "userId",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Demote a user to a normal group member."
        },
        {
          "info": {
            "name": "Show outstanding invitations for a group.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/invitation",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              },
              {
                "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": "Show outstanding invitations for a group."
        },
        {
          "info": {
            "name": "Invite a user to join a group, or accept a user's request to join.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/invitation",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              },
              {
                "name": "level",
                "value": "",
                "type": "query",
                "description": "The access level the user will be given when they accept the invitation."
              },
              {
                "name": "quiet",
                "value": "",
                "type": "query",
                "description": "If you do not want this action to send an email to the target user, set this to true."
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "Add user directly rather than sending an invitation (admin-only option)."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "userId",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "The \"force\" option to this endpoint is only available to administrators and can be used to bypass the invitation process and instead add the user directly to the group."
        },
        {
          "info": {
            "name": "List members of a group.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/member",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              },
              {
                "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": "List members of a group."
        },
        {
          "info": {
            "name": "Request to join a group, or accept an invitation to join.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/member",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ]
          },
          "docs": "Request to join a group, or accept an invitation to join."
        },
        {
          "info": {
            "name": "Remove a user from a group, or uninvite them.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/member",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "userId",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "If the specified user is not yet a member of the group, this will delete any outstanding invitation or membership request for the user. Passing no userId parameter will assume that the current user is removing themself."
        },
        {
          "info": {
            "name": "Promote a member to be a moderator of the group.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/moderator",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "userId",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Promote a member to be a moderator of the group."
        },
        {
          "info": {
            "name": "Demote a user to a normal group member.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://computablebrain.emory.edu/api/v1/group/:id/moderator",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the document."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "userId",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Demote a user to a normal group member."
        }
      ]
    }
  ],
  "bundled": true
}