---
updatedAt: 2025-02-14T12:41:47.000Z
agentTools:
  projectIndex: https://developer.walkme.com/llms.txt
---

# Job State Object

## Job State Object

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Property
      </th>

      <th style={{ textAlign: "left" }}>
        Data Type
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        jobId
      </td>

      <td style={{ textAlign: "left" }}>
        UUID v4
      </td>

      <td style={{ textAlign: "left" }}>
        Created Job ID
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        userId
      </td>

      <td style={{ textAlign: "left" }}>
        number
      </td>

      <td style={{ textAlign: "left" }}>
        User id
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        jobType
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Job Type can have the following possible values:\
        IMPORT\
        EXPORT
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        jobState
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Current Job State:\
        CREATED\
        IN PROGRESS\
        COMPLETED\
        FAILED
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        startedAt
      </td>

      <td style={{ textAlign: "left" }}>
        date
      </td>

      <td style={{ textAlign: "left" }}>
        Date when the job was created. Format is ISO8601.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        endedAt
      </td>

      <td style={{ textAlign: "left" }}>
        date
      </td>

      <td style={{ textAlign: "left" }}>
        Date when the job ended. Format is ISO8601.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        progress
      </td>

      <td style={{ textAlign: "left" }}>
        number
      </td>

      <td style={{ textAlign: "left" }}>
        percent of completion
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        stage
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        completion stage
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        errorMessage
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Error description
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        metadata
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        Additional information about process
      </td>
    </tr>
  </tbody>
</Table>

## Metadata object

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        property
      </th>

      <th style={{ textAlign: "left" }}>
        Data type
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        transactionId
      </td>

      <td style={{ textAlign: "left" }}>
        UUID v4
      </td>

      <td style={{ textAlign: "left" }}>
        Request ID
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        languageId
      </td>

      <td style={{ textAlign: "left" }}>
        number
      </td>

      <td style={{ textAlign: "left" }}>
        Language ID
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        languageDisplayName
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Reserved
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        finalReport
      </td>

      <td style={{ textAlign: "left" }}>
        array
      </td>

      <td style={{ textAlign: "left" }}>
        Detailed report
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        fileType
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        File Type:\
        XLIFF\
        EXCEL\
        RESJSON
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        assetId
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Asset ID
      </td>
    </tr>
  </tbody>
</Table>

## Report object

<Table align={["left","left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>

      </th>

      <th style={{ textAlign: "left" }}>

      </th>

      <th style={{ textAlign: "left" }}>

      </th>

      <th style={{ textAlign: "left" }}>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        isErrorMessage
      </td>

      <td style={{ textAlign: "left" }}>
        boolean
      </td>

      <td style={{ textAlign: "left" }}>
        Does report contain failure or success result
      </td>

      <td style={{ textAlign: "left" }}>
        Required
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        message
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Contains result text about executed import operation
      </td>

      <td style={{ textAlign: "left" }}>
        Required
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        status
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Processed items status (“saved” or “skipped”)
      </td>

      <td style={{ textAlign: "left" }}>
        Required
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        scope
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Scope of occurred error
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        exceptionType
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Error or warning
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        userLanguageId
      </td>

      <td style={{ textAlign: "left" }}>
        number
      </td>

      <td style={{ textAlign: "left" }}>
        Language identifier
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        relatedObjectId
      </td>

      <td style={{ textAlign: "left" }}>
        number
      </td>

      <td style={{ textAlign: "left" }}>
        Regular translation item's property
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        languagePartType
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Regular translation item's property
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        translationKey
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Wysiwyg translation item's property
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        contextId
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Wysiwyg translation item's property
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        propertyName
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Name of translated field
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        contextLabel
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Wysiwyg translation item's property
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>
    </tr>
  </tbody>
</Table>