{
  "opencollection": "1.0.0",
  "info": {
    "name": "ChartHop access process API",
    "version": "V1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "process",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a number of previously run processes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/process",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "isAppProcess",
                "value": "",
                "type": "query",
                "description": "Boolean if an app process"
              },
              {
                "name": "appId",
                "value": "",
                "type": "query",
                "description": "App ID to filter by"
              },
              {
                "name": "parentProcessId",
                "value": "",
                "type": "query",
                "description": "Parent process ID to search for children"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type to filter by. Accepted values: ['auto', 'manual']"
              },
              {
                "name": "createAtFrom",
                "value": "",
                "type": "query",
                "description": "Create at instant from, inclusive"
              },
              {
                "name": "createAtUntil",
                "value": "",
                "type": "query",
                "description": "Create at instant until, exclusive"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Statuses to filter by, comma-separated. Accepted values: ['DONE', 'ERROR', 'PENDING', 'RUNNING', 'DONE_WITH_ERRORS']"
              },
              {
                "name": "isParentProcess",
                "value": "",
                "type": "query",
                "description": "Boolean if a parent process"
              },
              {
                "name": "processTypes",
                "value": "",
                "type": "query",
                "description": "Process types to filter by, comma-separated."
              },
              {
                "name": "searchValue",
                "value": "",
                "type": "query",
                "description": "Search term for general filtering"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "from id"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "limit"
              },
              {
                "name": "syncDirections",
                "value": "",
                "type": "query",
                "description": "direction"
              },
              {
                "name": "syncCauses",
                "value": "",
                "type": "query",
                "description": "V2 Causes to filter by, comma-separated. Accepted values: ['MANUAL', 'AUTO', 'EVENT_BASED]"
              },
              {
                "name": "runUserId",
                "value": "",
                "type": "query",
                "description": "The user id under which the process is run"
              }
            ]
          },
          "docs": "Retrieve a number of previously run processes"
        },
        {
          "info": {
            "name": "Creates a new process in the pending state",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/process",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Creates a new process in the pending state"
        },
        {
          "info": {
            "name": "Get last success sync and last sync for given appUserId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/process/last-sync/:appUserId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "appUserId",
                "value": "",
                "type": "path",
                "description": "app user id"
              }
            ]
          },
          "docs": "Get last success sync and last sync for given appUserId"
        },
        {
          "info": {
            "name": "Creates a new process in the pending state",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/process/self-serve",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Process type"
              },
              {
                "name": "maxRows",
                "value": "",
                "type": "query",
                "description": "Max rows allowed in an imported spreadsheet file"
              },
              {
                "name": "minColumns",
                "value": "",
                "type": "query",
                "description": "Min columns required in an imported spreadsheet file"
              },
              {
                "name": "isSync",
                "value": "",
                "type": "query",
                "description": "Whether the created process is sync flow or manual flow"
              }
            ]
          },
          "docs": "Creates a new process in the pending state"
        },
        {
          "info": {
            "name": "Creates a new process with a specified createId in the pending state",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:createIdOverride",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "createIdOverride",
                "value": "",
                "type": "path",
                "description": "created user id override"
              }
            ]
          },
          "docs": "Creates a new process with a specified createId in the pending state"
        },
        {
          "info": {
            "name": "Check the status of a particular process",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              },
              {
                "name": "showState",
                "value": "",
                "type": "query",
                "description": "showState"
              }
            ]
          },
          "docs": "Check the status of a particular process"
        },
        {
          "info": {
            "name": "Update the status of a process, marking its progress or setting status to DONE or ERROR",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Update the status of a process, marking its progress or setting status to DONE or ERROR"
        },
        {
          "info": {
            "name": "Decrement the step of an asynchronous process",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/decrement",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Decrement the step of an asynchronous process"
        },
        {
          "info": {
            "name": "Get events associated to a particular process",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/events",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Get events associated to a particular process"
        },
        {
          "info": {
            "name": "Download the file associated with a particular process",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/file",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Download the file associated with a particular process"
        },
        {
          "info": {
            "name": "Upload a file to be attached to a process, and mark the process as complete",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/file",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Upload a file to be attached to a process, and mark the process as complete"
        },
        {
          "info": {
            "name": "Increment the step of an asynchronous process",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/increment",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Increment the step of an asynchronous process"
        },
        {
          "info": {
            "name": "Download the newline-delimited JSON log associated with a particular process",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/log",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Download the newline-delimited JSON log associated with a particular process"
        },
        {
          "info": {
            "name": "Append log messages to a process",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/log",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Append log messages to a process"
        },
        {
          "info": {
            "name": "Resume an asynchronous process",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/resume",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Resume an asynchronous process"
        },
        {
          "info": {
            "name": "Resume an asynchronous process",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/resumeWithFile",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Resume an asynchronous process"
        },
        {
          "info": {
            "name": "Update process state",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v1/org/:orgId/process/:processId/state",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "process id"
              }
            ]
          },
          "docs": "Update process state"
        }
      ]
    }
  ],
  "bundled": true
}