{ "opencollection": "1.0.0", "info": { "name": "HighBond API Reference Actions Questionnaires API", "version": "1.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Questionnaires", "type": "folder" }, "items": [ { "info": { "name": "List of questionnaires\n", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:collection_id/questionnaires", "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." } ] }, "docs": "Get a list of all questionnaires inside a collection." }, { "info": { "name": "Create a questionnaire", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new questionnaire in an existing collection.\n\nLimitations:\n* Your organization can have a maximum of 14,000 questionnaires.\n" }, { "info": { "name": "Get a questionnaire", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/: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 questionnaire." }, { "info": { "name": "Update a questionnaire", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/: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 questionnaire, like renaming it." }, { "info": { "name": "Delete a questionnaire", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/: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 questionnaire.\n\n> **Caution -**\nDeleting a questionnaire also permanently removes questions associated with the questionnaire.\n\n\n> **Note -**\nQuestionnaires that are associated with a Survey, Event Report, or trigger cannot be deleted.\n" }, { "info": { "name": "Create a simple question", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/:questionnaire_id/simple_questions", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "questionnaire_id", "value": "", "type": "path", "description": "The ID of the questionnaire." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Email, Date, Numeric, Short Answer, Paragraph, Attachment or Digital Signature question.\n" }, { "info": { "name": "Get a simple question", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/simple_questions/: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 simple question." }, { "info": { "name": "Update a simple question", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/simple_questions/: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 an existing simple question." }, { "info": { "name": "Create a choice question", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/:questionnaire_id/choice_questions", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "questionnaire_id", "value": "", "type": "path", "description": "The ID of the questionnaire." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Single Choice, Multiple Choice or Dropdown question in a questionnaire." }, { "info": { "name": "Get a choice question", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/choice_questions/: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 choice question." }, { "info": { "name": "Update a choice question", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/choice_questions/: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 an existing choice question" }, { "info": { "name": "Create a numeric scale question", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/:questionnaire_id/numeric_scale_questions", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "questionnaire_id", "value": "", "type": "path", "description": "The ID of the questionnaire." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Numeric Scale question in a questionnaire." }, { "info": { "name": "Get a numeric scale question", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/numeric_scale_questions/: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 Numeric Scale question." }, { "info": { "name": "Update a numeric scale question", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/numeric_scale_questions/: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 an existing numeric scale question" }, { "info": { "name": "Create a page break", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/:questionnaire_id/page_breaks", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "questionnaire_id", "value": "", "type": "path", "description": "The ID of the questionnaire." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new questionnaire page break in an existing questionnaire.\n\n> **Note**: - Request body is **optional** when creating a Page Break.\n>\n> When absent, the new page break will be appended to bottom of the items in the questionnaire.\n>\n> When present, the `position` value must be provided according to the schema.\n" }, { "info": { "name": "Get a page break", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/page_breaks/: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 questionnaire page break." }, { "info": { "name": "Update a page break", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/page_breaks/: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": "Change a page break's position in a questionnaire" }, { "info": { "name": "Create a section", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/:questionnaire_id/sections", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "questionnaire_id", "value": "", "type": "path", "description": "The ID of the questionnaire." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new questionnaire section in an existing questionnaire." }, { "info": { "name": "Get a section", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/sections/: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 questionnaire section." }, { "info": { "name": "Update a section", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/sections/: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 questionnaire section, like renaming it." }, { "info": { "name": "List of questionnaire items\n", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaires/:questionnaire_id/items", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "questionnaire_id", "value": "", "type": "path", "description": "The ID of the questionnaire." } ] }, "docs": "Get a list of all questionnaire items inside a questionnaire." }, { "info": { "name": "Delete a questionnaire item", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{server}/v1/orgs/:org_id/questionnaire/items/: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 questionnaire item in a questionnaire.\n" } ] } ], "bundled": true }