| GET | /api/automation/availabletypes/{RmsTableCtxId} |
|---|
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 ListItemModel:
list_item_id: Optional[str] = None
name: Optional[str] = None
description: Optional[str] = None
short_name: Optional[str] = None
is_default: bool = False
order: int = 0
list_item_traffic_light_id: Optional[str] = None
primary_list_item_image_id: Optional[str] = None
primary_list_item_image_url: Optional[str] = None
primary_image_thumbnail_url: Optional[str] = None
owner_contact_id: Optional[str] = None
record_status: Optional[str] = None
# @ApiResponse(Description="A list of automation types assignable to a particular object type")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAutomationTypesByObjectTypeResponse:
# @ApiMember(Description="List of applicable automation types.")
automation_types: Optional[List[ListItemModel]] = None
"""
List of applicable automation types.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get automation types available for the specified object type (rmsTableCtxId)")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAutomationTypesByObjectType:
"""
Get automation types available for the specified object type (rmsTableCtxId)
"""
# @ApiMember(Description="RmsTableCtx Id to filter available automation types by", ParameterType="path")
rms_table_ctx_id: Optional[str] = None
"""
RmsTableCtx Id to filter available automation types by
"""
Python GetAutomationTypesByObjectType DTOs
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 /api/automation/availabletypes/{RmsTableCtxId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"AutomationTypes":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}