{"info":{"version":"4.0","title":"Documentation Norce Commerce Connect Job Service","description":"The Job Service has Entities and Operations concerned with jobs created in Norce Commerce."},"paths":{"/Job/Get":{"get":{"tags":["Job"],"summary":"Get Job","description":"Get job information by it's id.<br/>Read more about the method <a href='/jobintegration/#jobget'>here</a>.","operationId":"Get","parameters":[{"schema":{"type":"integer","format":"int32"},"name":"id","in":"query","required":true,"description":"Job id"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/JobDto"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/Job/GetLog":{"get":{"tags":["Job"],"summary":"Get Job log","description":"Get log for given job by it's id. <br/>Read more about the method <a href='/jobintegration/#joblogget'>here</a>.","operationId":"GetLog","parameters":[{"schema":{"type":"integer","format":"int32"},"name":"id","in":"query","required":true,"description":"Job id"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobLogDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/JobLogDto"}}}},"400":{"description":"Bad Request"},"404":{"description":"Job not found"},"500":{"description":"Internal Server Error"}}}},"/Job/List":{"get":{"tags":["Job"],"summary":"List Job","description":"Lists all Jobs in the logs.<br/>Read more about the method <a href='/jobintegration/#joblist'>here</a>.","operationId":"List","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobDto"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobDto"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/Job/Ping":{"get":{"tags":["Healthcheck"],"summary":"Ping","description":"Check if Norce Commerce Connect is answering.<br/>Read more about the method <a href='/jobintegration/#ping'>here</a>.","operationId":"Ping","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/Job/Restart":{"post":{"tags":["Job"],"summary":"Restart Job","description":"Restarts a given Job. The job must have finished (i.e. have status 2 or 3) before it may be restarted. A job can be restarted for two weeks, after that the initial payload is discarded.<br/>Read more about the method <a href='/jobintegration/#restartjob'>here</a>.","operationId":"Restart","parameters":[{"schema":{"type":"integer","format":"int32"},"name":"id","in":"query","required":true,"description":"Job id"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}}},"openapi":"3.0.4","servers":[{"url":"https://customer-slug.api-se.norce.tech/commerce/connect/4.0"}],"components":{"schemas":{"JobDto":{"properties":{"Fail":{"description":"Number of items which failed to be imported.","type":"integer","format":"int32"},"Insert":{"description":"Number of inserts in all database tables triggered by import.","type":"integer","format":"int32"},"IsFinished":{"description":"Shows if job is finished.","type":"boolean"},"JobId":{"description":"Job identifier.","type":"integer","format":"int32"},"LastUpdated":{"description":"Timestamp when job information was last updated.","type":"string","format":"DateTime"},"RunTime":{"description":"Job duration.","type":"string","format":"TimeSpan"},"Start":{"description":"Job start time.","type":"string","format":"DateTime"},"StatusId":{"description":"Job status:<br>1 = Initialized<br>2 = Succeeded<br>3 = Failed<br>4 = Validation failed","type":"integer","format":"int32"},"Stop":{"description":"Job stop time.","type":"string","format":"DateTime"},"StorageName":{"description":"Relative path to stored import file.","type":"string","format":"uri"},"Totals":{"description":"Total number of import items.","type":"integer","format":"int32"},"Updates":{"description":"Number of updates in all database tables triggered by import.","type":"integer","format":"int32"}},"type":"object","format":"JobDto"},"JobLogDto":{"description":"Log record for a specific job","properties":{"SeverityId":{"description":"Severity of log. 1 = Information, 2 = Warning, 3 = Error","type":"integer","format":"int32"},"Message":{"description":"Log message","type":"string"},"TimeStamp":{"description":"Log timestamp","type":"string","format":"DateTime"},"ImportedRow":{"description":"Affected row from import","type":"string"}},"type":"object","format":"JobLogDto"},"JobResponse":{"description":"General response for async Connect jobs","properties":{"StatusCode":{"description":"Status of the job","type":"string"},"Description":{"description":"Short message describing the job","type":"string"},"JobId":{"description":"Norce Commerce interal id created for this job. Refer to this for future requests.","type":"string","format":"int32"},"ValidationSummary":{"description":"Short validation of request data","$ref":"#/components/schemas/ValidationSummary"}}},"ValidationSummary":{"description":"Validation data for accepted payload","properties":{"NrOfItemsInTotal":{"description":"Total number of items in payload.","type":"integer","format":"int32"},"NrOfValidationFailures":{"description":"Number of items that failed initial validation.","type":"integer","format":"int32"},"Messages":{"description":"Messages concerning the validation.","type":"array","items":{"type":"string"}}}}}}}