{
  "opencollection": "1.0.0",
  "info": {
    "name": "HighBond API Reference Actions Compliance Maps API",
    "version": "1.1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Compliance Maps",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get compliance regulations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_regulations",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "fields[compliance_regulations]",
                "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": "Filters the response list based on the name match."
              },
              {
                "name": "filter[external_id]",
                "value": "",
                "type": "query",
                "description": "Filters the response list based on the external ID match."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts the response lists by created_at."
              },
              {
                "name": "show_parital_results",
                "value": "",
                "type": "query",
                "description": "Show partial results for the compliance regulations."
              }
            ]
          },
          "docs": "Get a list of all compliance regulations in an organization.\n\n> **Note —**\nOnly root users can read the `premium` and `subscription_types` attributes.\n"
        },
        {
          "info": {
            "name": "Create a compliance regulation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_regulations",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "fields[compliance_regulations]",
                "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 compliance regulation in an existing organization.\n\n<strong>Limitations</strong>:\n* There can be a maximum of 500 compliance regulations per HighBond instance.\n\n> **Note —**\nSystem and root users can edit the `disclaimer`, `report_disclaimer`, `requirement_disclaimer` and `locked` attributes. Only root users can edit the `premium` and `subscription_types` attributes.\n"
        },
        {
          "info": {
            "name": "Get a compliance regulation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_regulations/: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[compliance_regulations]",
                "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 compliance regulation.\n\n> **Note —**\nOnly root users can read the `premium` and `subscription_types` attributes.\n"
        },
        {
          "info": {
            "name": "Update a compliance regulation",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_regulations/: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[compliance_regulations]",
                "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 compliance regulation in an organization.\n\n> **Note —**\nSystem and root users can edit the `disclaimer`, `report_disclaimer`, `requirement_disclaimer` and `locked` attributes. Only root users can edit the `premium` and `subscription_types` attributes.\n"
        },
        {
          "info": {
            "name": "Delete a compliance regulation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_regulations/: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 compliance regulation from an organization.\n"
        },
        {
          "info": {
            "name": "Get compliance requirements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_regulations/:compliance_regulation_id/compliance_requirements",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "compliance_regulation_id",
                "value": "",
                "type": "path",
                "description": "The ID of the regulation."
              },
              {
                "name": "fields[compliance_requirements]",
                "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": "fields[compliance_mappings]",
                "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[identifier]",
                "value": "",
                "type": "query",
                "description": "Filters the response list based on the identifier match."
              },
              {
                "name": "filter[name]",
                "value": "",
                "type": "query",
                "description": "Filters the response list based on the name match."
              },
              {
                "name": "filter[search]",
                "value": "",
                "type": "query",
                "description": "Filters the response list based on the search match in description or name."
              },
              {
                "name": "filter[parent_id]",
                "value": "",
                "type": "query",
                "description": "Filters the response list based on the parent ID match. With filter[parent_id]=null we should get back the parent elements."
              }
            ]
          },
          "docs": "Get a list of all compliance requirements in a regulation."
        },
        {
          "info": {
            "name": "Create a compliance requirement",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_regulations/:compliance_regulation_id/compliance_requirements",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "compliance_regulation_id",
                "value": "",
                "type": "path",
                "description": "The ID of the regulation."
              },
              {
                "name": "fields[compliance_requirements]",
                "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": "fields[compliance_mappings]",
                "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 compliance requirement in an existing organization.\n\n<strong>Limitations</strong>:\n* There can be a maximum of 5000 compliance requirements per compliance regulation.\n"
        },
        {
          "info": {
            "name": "Get a compliance requirement",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_requirements/: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[compliance_requirements]",
                "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": "fields[compliance_mappings]",
                "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 compliance requirement."
        },
        {
          "info": {
            "name": "Update a compliance requirement",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_requirements/: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[compliance_requirements]",
                "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": "fields[compliance_mappings]",
                "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 compliance requirement in an organization."
        },
        {
          "info": {
            "name": "Delete a compliance requirement",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_requirements/: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 compliance requirement from an organization.\n"
        },
        {
          "info": {
            "name": "Create a link between requirements",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/related_requirements",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "fields[related_compliance_requirements]",
                "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": "<p>Organizations typically need to be compliant with multiple standards and regulations that may have related or overlapping requirements. Related requirements indicate that controls implemented for one requirement should effectively address another (related) requirement.</p> <p>To link two requirements, you need the requirement ID for each requirement, whether the related requirement supports or overlaps the first requirement, the strength of the relationship, and whether the link should be act"
        },
        {
          "info": {
            "name": "Get a link between requirements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/related_requirements/: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[related_compliance_requirements]",
                "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": "<p>For a given link between requirements, get detailed information about the relationship and the requirements that are related.</p> <p>Use the related requirements feature at your discretion and risk. You are responsible to apply professional judgment to determine the appropriate procedures, tests, or controls for your own use. <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=pm-relationships-controls-requirements\">Learn more</a>.</p>"
        },
        {
          "info": {
            "name": "Update a link between requirements",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/related_requirements/: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[related_compliance_requirements]",
                "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": "<p>Once a relationship is established between requirements, you can change any aspect of that relationship.</p> <p>To update a link, you need the id of the relationship that was generated when it was created. You also need the requirement ID for each requirement, whether the related requirement supports or overlaps the first requirement, the strength of the relationship, and whether the link should be active or not.</p> <p>Use the related requirements feature at your discretion and risk. You are"
        },
        {
          "info": {
            "name": "Delete a link between requirements",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/related_requirements/: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": "<p>Once a relationship is established between requirements, you can delete that relationship.</p> <p>Use the related requirements feature at your discretion and risk. You are responsible to apply professional judgment to determine the appropriate procedures, tests, or controls for your own use. <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=pm-relationships-controls-requirements\">Learn more</a>.</p>"
        },
        {
          "info": {
            "name": "Get related compliance requirements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_requirements/:compliance_requirement_id/related_requirements",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "compliance_requirement_id",
                "value": "",
                "type": "path",
                "description": "The ID of the requirement."
              },
              {
                "name": "fields[related_compliance_requirements]",
                "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": "fields[compliance_requirements]",
                "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": "fields[compliance_regulations]",
                "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": "<p>Get a full list of all related requirements in your organization that have a relationship strength of equivalent, strongly related, or moderately related, and details about those relationships and the requirements.</p> <p>Use the related requirements feature at your discretion and risk. You are responsible to apply professional judgment to determine the appropriate procedures, tests, or controls for your own use. <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=pm-"
        },
        {
          "info": {
            "name": "Create a compliance mapping",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_mappings",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "fields[compliance_mappings]",
                "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 compliance mapping in an existing organization.\n"
        },
        {
          "info": {
            "name": "Get a compliance mapping",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_mappings/: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[compliance_mappings]",
                "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 compliance mapping in an organization."
        },
        {
          "info": {
            "name": "Update a compliance mapping",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_mappings/: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[compliance_mappings]",
                "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 compliance mapping in an organization."
        },
        {
          "info": {
            "name": "Delete a compliance mapping",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/compliance_mappings/: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 compliance mapping from an organization.\n"
        }
      ]
    }
  ],
  "bundled": true
}