{
  "opencollection": "1.0.0",
  "info": {
    "name": "HighBond API Reference Actions Surveys API",
    "version": "1.1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Surveys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a survey",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/analyses/:analysis_id/surveys",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "analysis_id",
                "value": "",
                "type": "path",
                "description": "The ID of the analysis where the requested table will be created."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new, empty survey in an existing analysis.\n\n<strong>Limitations</strong>:\n* Your organization can have a maximum of 1,000 surveys.\n"
        },
        {
          "info": {
            "name": "Get a survey",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/surveys/: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 survey."
        },
        {
          "info": {
            "name": "Update a survey",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{server}/v1/orgs/:org_id/surveys/: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 survey, like renaming it."
        },
        {
          "info": {
            "name": "Delete a survey",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/surveys/: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 survey.\n\n> **Caution —**\nDeleting a survey also permanently removes associated records, interpretations, metrics, and triggers.\n"
        }
      ]
    }
  ],
  "bundled": true
}