GET | /jobs/{Id} |
---|
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
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IHasGetOptions, IGet):
embed: Optional[str] = None
@staticmethod
def response_type(): return TResponse
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetOperationTenanted(Generic[TResponse], GetOperationUnTenanted[TResponse], ITenantedRequest):
organisation_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Job(IIdentifiableResource):
machine_id: Optional[str] = None
name: Optional[str] = None
total_layers: Optional[int] = None
started_at: Optional[datetime.datetime] = None
finished_at: Optional[datetime.datetime] = None
aborted: Optional[bool] = None
id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetJobResponse:
response_status: Optional[ResponseStatus] = None
job: Optional[Job] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetJobRequest(GetOperationTenanted[GetJobResponse]):
id: Optional[str] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /jobs/{Id} HTTP/1.1 Host: foundrystage-api-app.azurewebsites.net Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"job":{"machineId":"String","name":"String","totalLayers":0,"finishedAt":null,"aborted":false,"id":"String"}}