{
  "opencollection": "1.0.0",
  "info": {
    "name": "HighBond API Reference Actions Projects API",
    "version": "1.1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Projects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/projects",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "fields[projects]",
                "value": "",
                "type": "query",
                "description": "Requesting the API to return only the specified fields. For more information, see <a href=\"#section/Making-requests\">Making requests</a>"
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The number of items returned per page. Default is 50. Maximum is 100."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "The Base64-encoded page number of records to return."
              },
              {
                "name": "filter[name]",
                "value": "",
                "type": "query",
                "description": "Filter by name.  Response will include partial matches and ignore case."
              },
              {
                "name": "filter[status]",
                "value": "",
                "type": "query",
                "description": "Requesting the API to filter results by project status. For more information, see <a href=\"#section/Making-requests\">Making requests</a>"
              }
            ]
          },
          "docs": "Get a list of all projects in an account."
        },
        {
          "info": {
            "name": "Create a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/projects",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "fields[projects]",
                "value": "",
                "type": "query",
                "description": "Requesting the API to return only the specified fields. For more information, see <a href=\"#section/Making-requests\">Making requests</a>"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new project from scratch. New projects can be created in `\"active\"` (by default) or `\"archive\"` states.\n\n<strong>Limitations</strong>:\n* There can be a maximum of 20,000 projects per HighBond instance.\n* When you first create a project, you cannot enable the following. However, you can enable them when you update the project later:\n  * <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=pm-certifications\" target=\"_blank\">Certifications</a> (`certification: true`"
        },
        {
          "info": {
            "name": "Get a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/projects/: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."
              },
              {
                "name": "fields[projects]",
                "value": "",
                "type": "query",
                "description": "Requesting the API to return only the specified fields. For more information, see <a href=\"#section/Making-requests\">Making requests</a>"
              }
            ]
          },
          "docs": "Get information about a project. You can retrieve projects in the state `\"active\"`, `\"archive\"`, or `\"delete\"`."
        },
        {
          "info": {
            "name": "Update a project",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/projects/: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."
              },
              {
                "name": "fields[projects]",
                "value": "",
                "type": "query",
                "description": "Requesting the API to return only the specified fields. For more information, see <a href=\"#section/Making-requests\">Making requests</a>"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Make changes to a project. Only projects in the state `\"active\"` or `\"delete\"` can be updated. Projects in the state `\"archive\"` cannot be updated.\n"
        },
        {
          "info": {
            "name": "Delete a project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/projects/: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."
              },
              {
                "name": "permanent",
                "value": "",
                "type": "query",
                "description": "Specifies that the project and all associated data should be permanently deleted."
              }
            ]
          },
          "docs": "Delete a project that you no longer require. Projects in the state `\"active\"`, `\"archived\"` or `\"delete\"` can be deleted.\n\nYou can temporarily or permanently delete a project:\n* By default, projects are temporarily deleted. The project is moved to a `\"delete\"` state and stored in the Project Library for 30 days. Project\nAdmins receive an email notification when a project has been temporarily deleted. After 30 days, the project is permanently deleted automatically.\n* To request a permanent deleti"
        },
        {
          "info": {
            "name": "Create project entity link",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/projects/:project_id/entities",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The ID of the project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Link entity to a project.\n\n> **Note**\n> * Tagging a project to an entity automatically tags a project with all ancestor entities and descendant entities.\n> * Request <a href=\"#operation/getProject\">Get a project</a> with `entities` query param to get the whole list of entities linked to a project.\n\n<strong>Limitations</strong>:\n  * Only 1 entity can be sent in the request payload.\n\n<a href=\"https://help.highbond.com/helpdocs/auditbond/en-us/Content/projects/admin/config/Setting_up_entity_tagging"
        },
        {
          "info": {
            "name": "Delete project entity link",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/projects/:project_id/entities/:id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The ID of the project."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the requested resource."
              }
            ]
          },
          "docs": "Permanently delete project entity link.\n\n> **Note -**\nUntagging a project from an entity automatically untags a project from all descendant entities.\n"
        }
      ]
    }
  ],
  "bundled": true
}