Accelerate the Value of Data

Get Job Status

View a Reltio D&B Connector Batch job status.

Get Job Status is part of the Reltio D&B Connector Batch. Learn more about related APIs in Batch APIs. The following are different job statuses and their descriptions:

Job StatusDescription
SCHEDULEDTask scheduled - has been successfully sent to datastore.
PROCESSINGTask execution in the process - some node of the connector has taken the job for execution and working on it.
IDLEThe task does nothing. The task was taken for execution, some operations were completed and no more work for now in this task. In this case, the Executor moves the task to IDLE state and exits to be free for other tasks. This is useful because of numerous timeouts occurring in some jobs. For example: starting export - nothing to do for hours, files uploaded to D&B FTP - nothing to do up to 24 hours.
CANCELEDThe user canceled the task. The status is updated in the database. The executors do not get the canceled tasks for execution. If the task has been executed and is in progress, it stops during the next database synchronization.
Note: You can cancel only active tasks. Active tasks: SCHEDULED, PROCESSING and IDLE
COMPLETEDTask completed without any errors.
Note: Task completed successfully does not mean that all files and records are uploaded/downloaded successfully. Please check the status of each file for details.
FAILEDTask failed - some unrecoverable error has occurred. For example: unable to start export task three times, timeout, unable to obtain export task status, D&B FTP is not available and so on.

Request

GET {DnBConnectorUri}/batch/{JobId}
Table 1. Parameters
Parameter Required Description
HeadersContent-TypeYes

Must be "Content-Type: application/json"

EnvironmentUrlYesEnvironment URL of the tenant.

For example: https://dev.reltio.com

AuthorizationNoAccess Token in format "Bearer <accessToken>" (see details in Authentication API)
Note: Required parameter if you do not specify Reltio-User and Reltio-Password.
TenantIdYesTenant Id: data is extracted from this tenant. Value: {{tenantID}}.
Reltio-UserNoReltio login
Note: Required parameter if Authorization is not specified.
Reltio-PasswordNoReltio password
Note: Required parameter if Authorization is not specified.

Example:

Request - Job Status

GET https://test-dnbconnector.reltio.com/b2bIntegration/dnb/batch/5741031244955648

Response - Job Status

{
    "environmentUrl": "https://dev.reltio.com",
    "tenantId": "o0wQnMResB8q1hs",
    "type": "batch",
    "status": "IDLE",
    "batchConfiguration": {
        "reltioUser": "some.user@reltio.com",
        "dnbUser": "dnbc",
        "dnbHost": "indiadev-01.its.reltio.com",
        "dnbProtocol": "ftp",
        "dnbPutPath": "/puts",
        "dnbGetPath": "/gets",
        "mergeOrgsWithSameDUNS": false,
        "minConfidenceCode": 7,
        "fileResponseSecondsLimit": 86400
    },
    "batchContext": {
        "exportTask": {
            "filter": "(startsWith(attributes.Name,'R')))",
            "finishedTime": 1549865018202
        },
        "putFilesTask": {
            exportTaskIds": [
                "41949723-470b-4d4d-9c9f-4fa35de0447d",
                "5f983618-ce38-4af8-b76d-db462ceca1cb",
                "a75a3a69-5cf5-4b0c-b559-933031bdecdc"
            ],
            "processedEntities": 11903,
            "filesIndex": 6,
            "finishedTime": 1549865299356,
            "readEntities": 11903
        },
        "getFilesTask": {
            "createdTime": 1549865269379,
            "fileEntries": [
                {
                    "filename": "5741031244955648.ref",
                    "createdDate": 1549865269575,
                    "processId": "data",
                    "requestLines": 2,
                    "receivedDate": 0,
                    "responseSize": 0,
                    "receivedLines": 0,
                    "status": "UPLOADED",
                    "forceS3": false,
                    "errorMessage": ""
                },
                {
                    "filename": "5741031244955648.glb",
                    "createdDate": 1549865269936,
                    "processId": "extmatch",
                    "requestLines": 1998,
                    "receivedDate": 0,
                    "responseSize": 0,
                    "receivedLines": 0,
                    "status": "UPLOADED",
                    "forceS3": false,
                    "errorMessage": ""
                },
                {
                    "filename": "5741031244955648_1.glb",
                    "createdDate": 1549865277539,
                    "requestLines": 2000,
                    "processId": "extmatch",
                    "receivedDate": 0,
                    "responseSize": 0,
                    "receivedLines": 0,
                    "status": "UPLOADED",
                    "forceS3": false,
                    "errorMessage": ""
                },               
                {
                    "filename": "5741031244955648_5.ref",
                    "createdDate": 1549865299156,
                    "requestLines": 2,
                    "receivedDate": 0,
                    "responseSize": 0,
                    "receivedLines": 0,
                    "status": "UPLOADED",
                    "forceS3": false,
                    "errorMessage": ""
                },
                {
                    "filename": "5741031244955648_5.glb",
                    "createdDate": 1549865299356,
                    "requestLines": 1900,
                    "receivedDate": 0,
                    "responseSize": 0,
                    "receivedLines": 0,
                    "status": "UPLOADED",
                    "forceS3": false,
                    "errorMessage": ""
                }
            ],
            "finishedTime": 0
        }
    }
}
Table 2. Fields
FieldsDescription
environmentUrlIndicates the environment URL of the tenant. For example, https://eu-360.reltio.com.
tenantIdIndicates the tenant ID. For example, nNP79XQvBNASxMj.
typeIndicates the type of job. We have several types of jobs:
  • batch - uses D&B Direct API
  • batch_plus - uses D&B Direct+ API
  • bkg_mon - background monitoring job
  • cron - scheduled jobs in a cron format
statusIndicates the status of the job. It can be any of the following as explained in the first table:
  • SCHEDULED
  • PROCESSING
  • IDLE
  • CANCELED
  • COMPLETED
  • FAILED
messageIndicates error message.

For example, REL0003: Reltio authorization error .

batchConfigurationIndicates the configuration of batch including parameters of a batch job. For example,
{"awsAccessKey":"key","s3Region":"eu-west-1","dnbUser":"user","dnbHost":"host","dnbRegistrationId":"reg",
"mergeOrgsWithSameDUNS":true,"overrideUpwHierarchy":false,
"minConfidenceCode":0,"fileResponseSecondsLimit":0,
"entityType":"configuration/entityTypes/B2BOrganization"}
forceIndicates enable or disable of multiple batch jobs while working on independent entities.
plus Indicates start or stop batch job on D&B Direct+ Mullti-process API.
cronExpressionIndicates the creation of periodic or deferred batch jobs.
timeZoneSpecifies the time zone in which the cron task will be executed. For example, timeZone: UTC.
nextDate Indicates the next scheduled date and time when the cron task will be executed.
startedTasksCountIndicates the count of sub-jobs that the corn job started.
failedToStartTasksCountIndicates incremental value if the job has an exception where the system cannot start the job.