Job Report

The Job Report model contains information about import and/or export jobs that you run using the ReachFive platform.

The Job Report object

{
    "total": 1,
    "items": [
        {
        "updated_at": "2020-09-10T15:27:35.477Z",
        "total_succeeded": 0,
        "total_operations": 0,
        "created_at": "2020-09-10T15:27:32.183Z",
        "definition": {
            "settings": {},
            "updated_at": "2020-06-04T14:16:34.658Z",
            "name": "export update",
            "recovery_strategy": "NONE",
            "description": "the export ",
            "created_at": "2020-06-04T14:16:34.658Z",
            "id": "AXJ_…​xTyFw",
            "type": "export",
            "enabled": true
            },
        "id": "AXR4oQNj…​4zl",
        "total_failed": 0,
        "type": "export",
        "status": "FAILURE"
        }
    ]
}

Job Report object fields

The definition part of the job report object is not sent in the End job notification webhook.
Field Type Description

updated_at

datetime

The date and time the job was updated.

total_succeeded

integer

Specifies the total number of jobs that succeeded.

total_operations

integer

Specifies the total number of operations.

created_at

datetime

The date and time the job was created.

definition

object

The job definition object.

See the Job Definition object for more details.

id

integer

Specifies the ID of the job.

total_failed

integer

Specifies the total number of jobs that failed.

type

string

Specifies the type of job.

status

enum

Specifies the status of the job.

  • SUCCESS

  • FAILURE

Job Definition object fields

The Job Definition object contains information about specific jobs.

Field Type Description

updated_at

datetime

The date and time the job definition was updated.

created_at

datetime

The date and time the job definition was created.

id

integer

Specifies the ID of the job definition.

type

string

Specifies the type of job definition.

description

string

A brief description of the job definition.

settings

object

An object containing low-level information about the job definition such as information on format (CSV or JSON).

name

string

Specifies the name of the job definition.

recovery_strategy

string

Defines the recovery strategy (if applicable).

enabled

boolean

Specifies whether or not the job definition is enabled.

  • true = enabled

  • false = disabled

Feedback