TicketUserServices

JobHeartbeatReportRequest

The following routes are available for this service:
POST	/JobHeartbeat

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JobHeartbeat:
    # @StringLength(100)
    job_name: Optional[str] = None

    # @StringLength(400)
    description: Optional[str] = None

    expected_interval_minutes: Optional[int] = None
    last_run_at: Optional[datetime.datetime] = None
    last_ok_at: Optional[datetime.datetime] = None
    # @StringLength(2147483647)
    last_result_json: Optional[str] = None

    items_processed: Optional[int] = None
    consecutive_failures: Optional[int] = None
    enabled: Optional[bool] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JobHeartbeatResult:
    item: Optional[JobHeartbeat] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JobHeartbeatReportRequest:
    job_name: Optional[str] = None
    phase: Optional[str] = None
    expected_interval_minutes: Optional[int] = None
    description: Optional[str] = None
    items_processed: Optional[int] = None
    result_json: Optional[str] = None

Python JobHeartbeatReportRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /JobHeartbeat HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	jobName: String,
	phase: String,
	expectedIntervalMinutes: 0,
	description: String,
	itemsProcessed: 0,
	resultJson: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	item: 
	{
		jobName: String,
		description: String,
		expectedIntervalMinutes: 0,
		lastRunAt: 0001-01-01,
		lastOkAt: 0001-01-01,
		lastResultJson: String,
		itemsProcessed: 0,
		consecutiveFailures: 0,
		enabled: False,
		updatedAt: 0001-01-01
	},
	statusCode: 0,
	message: String
}