{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Flow API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Flow",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Flows or Subflows",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows",
            "params": [
              {
                "name": "flowType",
                "value": "FLOW",
                "type": "query",
                "description": "Either of 'FLOW' or 'SUBFLOW'."
              },
              {
                "name": "ids",
                "value": "668e4b2d928d471e41da03d1,668e3ee2928d471e41da03cb",
                "type": "query",
                "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response."
              },
              {
                "name": "orgId",
                "value": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
                "type": "path",
                "description": "Organization ID."
              },
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Defines the number of the displayed page. The page number starts from 0."
              },
              {
                "name": "partialNameSearch",
                "value": "flow1",
                "type": "query",
                "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response."
              },
              {
                "name": "projectId",
                "value": "5e5c9ad6d61f870d6d778c1b",
                "type": "path",
                "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b."
              },
              {
                "name": "size",
                "value": "10",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              },
              {
                "name": "includePagination",
                "value": "false",
                "type": "query",
                "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\"."
              }
            ]
          },
          "docs": "Returns a list of flows in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]"
        },
        {
          "info": {
            "name": "Export a Flow or Subflow",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/:flowId:export",
            "params": [
              {
                "name": "flowId",
                "value": "661c7bc712eaf357de7e4aeb",
                "type": "path",
                "description": "ID of the flow/subflow to export."
              },
              {
                "name": "orgId",
                "value": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
                "type": "path",
                "description": "Organization ID."
              },
              {
                "name": "projectId",
                "value": "5e5c9ad6d61f870d6d778c1b",
                "type": "path",
                "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b."
              },
              {
                "name": "version",
                "value": "Version ID: 6679cb15f3398d4d1070a1e6.",
                "type": "query",
                "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'."
              }
            ]
          },
          "docs": "Returns the exported flow/subflow in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]"
        },
        {
          "info": {
            "name": "Publish a Flow or Subflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/:flowId:publish",
            "headers": [
              {
                "name": "TrackingId",
                "value": "491fed1e-de7f-11ef-9cd2-0242ac120002"
              }
            ],
            "params": [
              {
                "name": "flowId",
                "value": "661c7bc712eaf357de7e4aeb",
                "type": "path",
                "description": "ID of the flow/subflow to export."
              },
              {
                "name": "orgId",
                "value": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
                "type": "path",
                "description": "Organization ID."
              },
              {
                "name": "projectId",
                "value": "5e5c9ad6d61f870d6d778c1b",
                "type": "path",
                "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns the published flow in response.\n\nThe Publish API validates the basic structure of the flows. We recommend manually verifying the published flows before proceeding with live traffic.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]"
        },
        {
          "info": {
            "name": "Import a Flow or Subflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import",
            "headers": [
              {
                "name": "Content-Length",
                "value": "10"
              }
            ],
            "params": [
              {
                "name": "orgId",
                "value": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
                "type": "path",
                "description": "Organization ID."
              },
              {
                "name": "projectId",
                "value": "5e5c9ad6d61f870d6d778c1b",
                "type": "path",
                "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b."
              },
              {
                "name": "overwrite",
                "value": "yes",
                "type": "query",
                "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no."
              },
              {
                "name": "flowType",
                "value": "FLOW",
                "type": "query",
                "description": "Either of 'FLOW' or 'SUBFLOW'."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Returns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]"
        }
      ]
    }
  ],
  "bundled": true
}