{
  "opencollection": "1.0.0",
  "info": {
    "name": "Flowable REST Access Tokens Task Variables API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Task Variables",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List variables for a task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/runtime/tasks/:taskId/variables",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List variables for a task"
        },
        {
          "info": {
            "name": "Create new variables on a task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/runtime/tasks/:taskId/variables",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "type",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "scope",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (RestVariable or an Array of RestVariable) or by passing a multipart/form-data Object.\nIt is possible to create simple (non-binary) variable or list of variables or new binary variable \nAny number of variables can be passed into the request body array.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools."
        },
        {
          "info": {
            "name": "Get a variable from a task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/runtime/tasks/:taskId/variables/:variableName",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "variableName",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a variable from a task"
        },
        {
          "info": {
            "name": "Update an existing variable on a task",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/runtime/tasks/:taskId/variables/:variableName",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "variableName",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "type",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "scope",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (RestVariable) or by passing a multipart/form-data Object.\nIt is possible to update simple (non-binary) variable or  binary variable \nAny number of variables can be passed into the request body array.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools."
        },
        {
          "info": {
            "name": "Delete a variable on a task",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/flowable-rest/service/runtime/tasks/:taskId/variables/:variableName",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "variableName",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a variable on a task"
        },
        {
          "info": {
            "name": "Get the binary data for a variable",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/runtime/tasks/:taskId/variables/:variableName/data",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "variableName",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "The response body contains the binary value of the variable. When the variable is of type binary, the content-type of the response is set to application/octet-stream, regardless of the content of the variable or the request accept-type header. In case of serializable, application/x-java-serialized-object is used as content-type."
        },
        {
          "info": {
            "name": "List variables for a task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/cmmn-runtime/tasks/:taskId/variables",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List variables for a task"
        },
        {
          "info": {
            "name": "Create new variables on a task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/cmmn-runtime/tasks/:taskId/variables",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "type",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "scope",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (RestVariable or an Array of RestVariable) or by passing a multipart/form-data Object.\nIt is possible to create simple (non-binary) variable or list of variables or new binary variable \nAny number of variables can be passed into the request body array.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools."
        },
        {
          "info": {
            "name": "Get a variable from a task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/cmmn-runtime/tasks/:taskId/variables/:variableName",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "variableName",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a variable from a task"
        },
        {
          "info": {
            "name": "Update an existing variable on a task",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/cmmn-runtime/tasks/:taskId/variables/:variableName",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "variableName",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "type",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "scope",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "This endpoint can be used in 2 ways: By passing a JSON Body (RestVariable) or by passing a multipart/form-data Object.\nIt is possible to update simple (non-binary) variable or  binary variable \nAny number of variables can be passed into the request body array.\nNB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools."
        },
        {
          "info": {
            "name": "Delete a variable on a task",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/flowable-rest/service/cmmn-runtime/tasks/:taskId/variables/:variableName",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "variableName",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a variable on a task"
        },
        {
          "info": {
            "name": "Get the binary data for a variable",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/cmmn-runtime/tasks/:taskId/variables/:variableName/data",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              },
              {
                "name": "variableName",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Scope of variable to be returned. When local, only task-local variable value is returned. When global, only variable value from the task’s parent execution-hierarchy are returned. When the parameter is omitted, a local variable will be returned if it exists, otherwise a global variable."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "The response body contains the binary value of the variable. When the variable is of type binary, the content-type of the response is set to application/octet-stream, regardless of the content of the variable or the request accept-type header. In case of serializable, application/x-java-serialized-object is used as content-type."
        }
      ]
    }
  ],
  "bundled": true
}