{
  "opencollection": "1.0.0",
  "info": {
    "name": "HighBond API Reference Actions Workflows in Asset Inventory/Asset Manager API",
    "version": "1.1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workflows in Asset Inventory/Asset Manager",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Workflows",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/workflows",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              }
            ]
          },
          "docs": "List Workflows and their metadata for an organization. Does not include relationships with other entities (statuses, events, etc)."
        },
        {
          "info": {
            "name": "Create a workflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/workflows",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new, empty workflow in an organization."
        },
        {
          "info": {
            "name": "Get a workflow",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/workflows/: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": "include",
                "value": "",
                "type": "query",
                "description": "Include information about the associated resources."
              }
            ]
          },
          "docs": "Get information about a workflow including all of its statuses, events and handlers if requested."
        },
        {
          "info": {
            "name": "Update a workflow",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/workflows/: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 metadata for an existing workflow, such as changing the name or the description."
        },
        {
          "info": {
            "name": "Delete a workflow",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/workflows/: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 workflow.\n\n<strong>Locked workflows cannot be deleted.</strong>\n\n<strong>System workflows cannot be deleted.</strong>\n\n<strong>Workflows linked to an asset type or asset record type cannot be deleted.</strong>\n"
        },
        {
          "info": {
            "name": "Get a workflow by api name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/workflows/:api_name",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "api_name",
                "value": "",
                "type": "path",
                "description": "The api name of the workflow"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include information about the associated resources."
              }
            ]
          },
          "docs": "Get information about a workflow, using api_name, including all of its statuses, events and handlers if requested."
        },
        {
          "info": {
            "name": "Create a workflow status",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/workflows/:workflow_id/statuses",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              },
              {
                "name": "workflow_id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new status in a workflow.\n\nNote: Creating a new default status will unset the previous default status.\n"
        },
        {
          "info": {
            "name": "Get a workflow status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/statuses/: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": "include",
                "value": "",
                "type": "query",
                "description": "If specified, the status's associated events will be included in the `included` object"
              }
            ]
          },
          "docs": "Get information about a workflow status."
        },
        {
          "info": {
            "name": "Update a workflow status",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/statuses/: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 workflow status.\n\nNotes regarding default statuses:\n- updating a status to be the new default status will unset the previous default status\n- the current default status cannot be unset directly since otherwise there would be no default status anymore\n"
        },
        {
          "info": {
            "name": "Delete a workflow status",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/statuses/: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": "force_delete",
                "value": "",
                "type": "query",
                "description": "If set to true, the status will be deleted regardless of default, locked, or linked items conditions. System statuses cannot be deleted, even with this set to true."
              }
            ]
          },
          "docs": "Permanently delete a workflow status.\n\n<strong>Locked workflow statuses cannot be deleted.</strong>\n\n<strong>System workflow statuses cannot be deleted.</strong>\n\n<strong>Statuses that are the default in the workflow cannot be deleted.</strong>\n\n<strong>Statuses linked to an asset or asset record cannot be deleted.</strong>\n"
        },
        {
          "info": {
            "name": "Create a status event mapping",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{server}/v1/orgs/:org_id/status_event_mappings",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The ID of the HighBond instance."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Associating an event to a status"
        },
        {
          "info": {
            "name": "Get a status event mapping",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{server}/v1/orgs/:org_id/status_event_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": "Get the mapping between a status and an event."
        },
        {
          "info": {
            "name": "Update a status event mapping",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{server}/v1/orgs/:org_id/status_event_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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the mapping between a status and an event."
        },
        {
          "info": {
            "name": "Delete a status event mapping",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{server}/v1/orgs/:org_id/status_event_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 status event mapping."
        }
      ]
    }
  ],
  "bundled": true
}