COMMERCE CONNECT

Job Service

JobDto

Documentation Norce Commerce Connect Job Service (4.0)

The Job Service has Entities and Operations concerned with jobs created in Norce Commerce.

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://customer-slug.api-se.norce.tech/commerce/connect/4.0/

Schemas

JobDto

Failinteger(int32)

Number of items which failed to be imported.

Insertinteger(int32)

Number of inserts in all database tables triggered by import.

IsFinishedboolean

Shows if job is finished.

JobIdinteger(int32)

Job identifier.

LastUpdatedstring(DateTime)

Timestamp when job information was last updated.

RunTimestring(TimeSpan)

Job duration.

Startstring(DateTime)

Job start time.

StatusIdinteger(int32)

Job status:
1 = Initialized
2 = Succeeded
3 = Failed
4 = Validation failed

Stopstring(DateTime)

Job stop time.

StorageNamestring(uri)

Relative path to stored import file.

Totalsinteger(int32)

Total number of import items.

Updatesinteger(int32)

Number of updates in all database tables triggered by import.

{
  "Fail": 0,
  "Insert": 0,
  "IsFinished": true,
  "JobId": 0,
  "LastUpdated": "string",
  "RunTime": "string",
  "Start": "string",
  "StatusId": 0,
  "Stop": "string",
  "StorageName": "http://example.com",
  "Totals": 0,
  "Updates": 0
}

JobLogDto

Log record for a specific job

SeverityIdinteger(int32)

Severity of log. 1 = Information, 2 = Warning, 3 = Error

Messagestring

Log message

TimeStampstring(DateTime)

Log timestamp

ImportedRowstring

Affected row from import

{
  "SeverityId": 0,
  "Message": "string",
  "TimeStamp": "string",
  "ImportedRow": "string"
}

JobResponse

General response for async Connect jobs

StatusCodestring

Status of the job

Descriptionstring

Short message describing the job

JobIdstring(int32)

Norce Commerce interal id created for this job. Refer to this for future requests.

ValidationSummaryobject(ValidationSummary)

Validation data for accepted payload

{
  "StatusCode": "string",
  "Description": "string",
  "JobId": "string",
  "ValidationSummary": {
    "NrOfItemsInTotal": 0,
    "NrOfValidationFailures": 0,
    "Messages": [ … ]
  }
}

ValidationSummary

Validation data for accepted payload

NrOfItemsInTotalinteger(int32)

Total number of items in payload.

NrOfValidationFailuresinteger(int32)

Number of items that failed initial validation.

MessagesArray of strings

Messages concerning the validation.

{
  "NrOfItemsInTotal": 0,
  "NrOfValidationFailures": 0,
  "Messages": [
    "string"
  ]
}

Job

Operations

Healthcheck

Operations