Field Squared API Services

<back to all web services

StatusCheck

Check on Status of Long Running Services

The following routes are available for this service:
GET/{Workspace}/StatusCheck/{Id}
GET/{Workspace}/StatusCheck
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 StatusCheckItem:
    rule_id: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    status: Optional[str] = None
    percent_complete: Optional[str] = None
    last_updated: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StatusCheck:
    """
    Check on Status of Long Running Services
    """

    workspace: Optional[str] = None
    id: Optional[str] = None
    items: Optional[List[StatusCheckItem]] = None

Python StatusCheck DTOs

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

HTTP + XML

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

GET /{Workspace}/StatusCheck/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml