> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aseeflow.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Task Variable (Binary)

> Sets the serialized value for a binary variable or the binary value for a file variable visible from the
task. A variable is visible from the task if it is a local task variable or declared in a parent scope of
the task. See documentation on
[visiblity of variables](https://docs.aseeflow.org/user-guide/process-engine/variables/).



## OpenAPI

````yaml /reference/rest/openapi-1.0.json post /task/{id}/variables/{varName}/data
openapi: 3.0.2
info:
  title: ASEE Flow Platform REST API
  description: OpenApi Spec for ASEE Flow Platform REST API.
  version: 1.0.0
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ASEE Flow Rest API
  url: https://docs.aseeflow.org/reference/rest/overview/
paths:
  /task/{id}/variables/{varName}/data:
    post:
      tags:
        - Task Variable
      summary: Update Task Variable (Binary)
      description: >-
        Sets the serialized value for a binary variable or the binary value for
        a file variable visible from the

        task. A variable is visible from the task if it is a local task variable
        or declared in a parent scope of

        the task. See documentation on

        [visiblity of
        variables](https://docs.aseeflow.org/user-guide/process-engine/variables/).
      operationId: setBinaryTaskVariable
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: The id of the task to retrieve the variable for.
        - name: varName
          in: path
          schema:
            type: string
          required: true
          description: The name of the variable to retrieve.
      requestBody:
        description: 'For binary variables a multipart form submit with the following parts:'
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MultiFormVariableBinaryDto'
            examples:
              example-1:
                summary: POST `/task/aTaskId/variables/aVarName/data` (1)
                description: Post binary content of a byte array variable.
                value: |2-

                                          ```
                                          ------------------------------354ddb6baeff
                                          Content-Disposition: form-data; name="data"; filename="image.png"
                                          Content-Type: application/octet-stream
                                          Content-Transfer-Encoding: binary

                                          <<Byte Stream ommitted>>
                                          ------------------------------354ddb6baeff
                                          Content-Disposition: form-data; name="valueType"
                                          Content-Type: text/plain; charset=US-ASCII
                                          Content-Transfer-Encoding: 8bit

                                          Bytes
                                          ------------------------------1e838f8f632a--
                                          ```
                                        
              example-2:
                summary: POST `/task/aTaskId/variables/aVarName/data` (2)
                description: Post the JSON serialization of a Java Class (**deprecated**).
                value: |2-

                                          ```
                                          ------------------------------1e838f8f632a
                                          Content-Disposition: form-data; name="type"
                                          Content-Type: text/plain; charset=US-ASCII
                                          Content-Transfer-Encoding: 8bit

                                          java.util.ArrayList<java.lang.Object>
                                          ------------------------------1e838f8f632a
                                          Content-Disposition: form-data; name="data"
                                          Content-Type: application/json; charset=US-ASCII
                                          Content-Transfer-Encoding: 8bit

                                          ["foo","bar"]
                                          ------------------------------1e838f8f632a--
                                          ```
                                        
              example-3:
                summary: POST `/task/aTaskId/variables/aVarName/data` (3)
                description: Post a text file.
                value: |2-

                                          ```
                                          ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y
                                          Content-Disposition: form-data; name="data"; filename="myFile.txt"
                                          Content-Type: text/plain; charset=US-ASCII
                                          Content-Transfer-Encoding: binary

                                          <<Byte Stream ommitted>>
                                          ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y
                                          Content-Disposition: form-data; name="valueType"
                                          Content-Type: text/plain; charset=US-ASCII
                                          Content-Transfer-Encoding: 8bit

                                          File
                                          ------------------------------1e838f8f632a--
                                          ```
                                        
      responses:
        '204':
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            The variable value or type is invalid, for example if no filename is
            set. See the

            [Introduction](https://docs.aseeflow.org/reference/rest/overview/#error-handling)

            for the error response format.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Variable name is `null`, or the Task id is `null` or does not exist.
            See the

            [Introduction](https://docs.aseeflow.org/reference/rest/overview/#error-handling)

            for the error response format.
components:
  schemas:
    MultiFormVariableBinaryDto:
      type: object
      properties:
        data:
          type: string
          format: binary
          nullable: true
          description: >-
            The binary data to be set.

            For File variables, this multipart can contain the filename, binary
            value and MIME type of the file variable to be set

            Only the filename is mandatory.
        valueType:
          type: string
          nullable: true
          enum:
            - Bytes
            - File
          description: >-
            The name of the variable type. Either Bytes for a byte array
            variable or File for a file variable.
    ExceptionDto:
      title: ExceptionDto
      type: object
      properties:
        type:
          type: string
          nullable: true
          description: An exception class indicating the occurred error.
        message:
          type: string
          nullable: true
          description: A detailed message of the error.
        code:
          type: number
          description: >-
            The code allows your client application to identify the error in an
            automated fashion.

            You can look up the meaning of all built-in codes and learn how to
            add custom codes

            in the [User
            Guide](https://docs.aseeflow.org/user-guide/process-engine/error-handling/#exception-codes).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````