jobs state (http://api.3plcentral.com/rels/jobs/state)
Resource:
a headless horseman job state
C# Rel Const:
Rels.JobSvc.State
URI template:
states/{id}
Obtain URI from:
Success status: 200
Name (* = required) Data Type Description
id * Int64
Type Description
StateId Int64
JobInfo Job.Models.JobInfoBase
JobId Int64
ThreePlIdentifier Generic.Models.ThreePlIdentifier
Guid string
Name string
Id int
CustomerId int? ...
RegisteredByJobId Int64? ...
MethodName string partially-qualified name of job method, beginning with top-level namespace after HH preramble, ending with a specific interface method
MethodParams String[] values of each of the method parameters, encoded as JSON; for parameter names see JobMethod
TraceMessages String[] concatenation of trace messages for all occurrences of a processing state
CreatedAt DateTime
ExpireAt DateTime? ...
CurrentJobState Common.Enum.JobState
- 1: Scheduled job will fire at EnqueueAt time
- 2: Enqueued job ready to run now as soon as a server has time
- 3: Processing job is now running
- 4: Succeeded job finished in a successful state
- 5: Failed job finished in a failed state, perhaps after having reached its max retry count
- 6: Deleted job has been dele--ggg--aaahh...
StateInfo Job.Models.StateTransition a job state transition
JobState Common.Enum.JobState
- 1: Scheduled job will fire at EnqueueAt time
- 2: Enqueued job ready to run now as soon as a server has time
- 3: Processing job is now running
- 4: Succeeded job finished in a successful state
- 5: Failed job finished in a failed state, perhaps after having reached its max retry count
- 6: Deleted job has been dele--ggg--aaahh...
Reason string varies based on Name Scheduled: a) NULL, b) Retry attempt m of n: then first few chars of exception msg Enqueued: a) NULL, b) Triggered by DelayedJobScheduler, c) Triggered by recurring job scheduler, d) Triggered via Dashboard UI Processing: NULL Succeeded: NULL Failed: An exception occurred during performance of the job. Deleted: Triggered via Dashboard UI other states not expected to encounter: Awaiting, Deleted
EnteredStateDateUtc DateTime When the job entered this particular state
EnqueuedQueue string relevant if state is Enqueued
ScheduledEnqueueAt DateTime? ... relevant if state is Scheduled
ProcessingServerName string relevant if state is Processing
ProcessingWorkerName string relevant if state is Processing
SucceededElapsedMilliseconds Int64? ... relevant if state is Succeeded
FailedExceptionType string relevant if state is Failed
FailedMessage string relevant if state is Failed
FailedStackTrace string relevant if state is Failed
Sample accept: application/hal+json
{
  "stateId": 1,
  "jobInfo": {
    "jobId": 1,
    "threePlIdentifier": {
      "guid": "str",
      "name": "str",
      "id": 3
    },
    "customerId": 1,
    "registeredByJobId": 1,
    "methodName": "str",
    "methodParams": [
      "str"
    ],
    "traceMessages": [
      "str"
    ],
    "createdAt": "2016-12-25T23:00:00",
    "expireAt": "2016-12-25T23:00:00"
  },
  "currentJobState": 1,
  "stateInfo": {
    "jobState": 1,
    "reason": "str",
    "enteredStateDateUtc": "2016-12-25T23:00:00",
    "enqueuedQueue": "str",
    "scheduledEnqueueAt": "2016-12-25T23:00:00",
    "processingServerName": "str",
    "processingWorkerName": "str",
    "succeededElapsedMilliseconds": 1,
    "failedExceptionType": "str",
    "failedMessage": "str",
    "failedStackTrace": "str"
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.