{
  "opencollection": "1.0.0",
  "info": {
    "name": "HighBond API Reference Actions Collections API",
    "version": "1.1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Collections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List collections inside an organization\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/collections",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              }
            ]
          },
          "docs": "Get a list of all collections"
        },
        {
          "info": {
            "name": "Create a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/collections",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new collection.\n\n<strong>Limitations</strong>:\n* Your organization can have a maximum of 2,000 collections.\n"
        },
        {
          "info": {
            "name": "Get a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the requested resource."
              }
            ]
          },
          "docs": "Get information about a collection."
        },
        {
          "info": {
            "name": "Update a collection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the requested resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Make changes to a collection, like renaming it. You do not need to update collections for them to reflect changes in data."
        },
        {
          "info": {
            "name": "Delete a collection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the requested resource."
              }
            ]
          },
          "docs": "Permanently delete a collection.\n\n> **Caution —**\nDeleting a collection also permanently removes all of the analyses and tables associated with the collection.\n"
        },
        {
          "info": {
            "name": "Add a user to Results collection member\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:collection_id/collections_members",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "collection_id",
                "value": "",
                "type": "path",
                "description": "The ID of the collection."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add users as a collection member with the predefined Results roles."
        },
        {
          "info": {
            "name": "Update a user role for a collection\n",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:collection_id/collections_members/:id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "collection_id",
                "value": "",
                "type": "path",
                "description": "The ID of the collection."
              },
              {
                "name": "collection_member_id",
                "value": "",
                "type": "path",
                "description": "The ID of the collection member."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the role of an existing collection members to any other predefined Result roles."
        },
        {
          "info": {
            "name": "Remove a user from the collection\n",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:collection_id/collections_members/:id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "collection_id",
                "value": "",
                "type": "path",
                "description": "The ID of the collection."
              },
              {
                "name": "collection_member_id",
                "value": "",
                "type": "path",
                "description": "The ID of the collection member."
              }
            ]
          },
          "docs": "Remove users from the collection members."
        }
      ]
    }
  ],
  "bundled": true
}