| GET | /api/automation/systemactions/{AutomationTypeId} |
|---|
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 system actions that can be used with a specified automation type")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSystemActionsForAutomationTypeResponse:
# @ApiMember(Description="List of applicable system actions.")
system_actions: Optional[List[ListItemModel]] = None
"""
List of applicable system actions.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get system actions for the specified automation type")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSystemActionsForAutomationType:
"""
Get system actions for the specified automation type
"""
# @ApiMember(Description="Automation Type Id to get the system actions for.", ParameterType="path")
automation_type_id: Optional[str] = None
"""
Automation Type Id to get the system actions for.
"""
# @ApiMember(Description="RmsTableCtx Id of the object type the automation is for. System Actions can change based on the type they apply to.", ParameterType="path")
rms_table_ctx_id: Optional[str] = None
"""
RmsTableCtx Id of the object type the automation is for. System Actions can change based on the type they apply to.
"""
Python GetSystemActionsForAutomationType DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/automation/systemactions/{AutomationTypeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
SystemActions:
[
{
Name: String,
Description: String,
ShortName: String,
IsDefault: False,
Order: 0,
PrimaryListItemImageUrl: String,
PrimaryImageThumbnailUrl: String,
RecordStatus: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}