| GET | /api/automation/{AutomationId}/documentation |
|---|
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 AutomationModel:
# @ApiMember(Description="The unique automation Id", ParameterType="query")
automation_id: Optional[str] = None
"""
The unique automation Id
"""
# @ApiMember(Description="The automation type Id", ParameterType="query")
automation_type_id: Optional[str] = None
"""
The automation type Id
"""
# @ApiMember(Description="The automation type", ParameterType="query")
automation_type: Optional[str] = None
"""
The automation type
"""
# @ApiMember(Description="The object this automation applies to", ParameterType="query")
object_id: Optional[str] = None
"""
The object this automation applies to
"""
# @ApiMember(Description="The object name this automation applies to", ParameterType="query")
object_name: Optional[str] = None
"""
The object name this automation applies to
"""
# @ApiMember(Description="The Id of the object type that this automation applies to. ", ParameterType="query")
rms_table_ctx_id_object: Optional[str] = None
"""
The Id of the object type that this automation applies to.
"""
# @ApiMember(Description="The name of the object type that this automation applies to.", ParameterType="query")
rms_table_ctx_name: Optional[str] = None
"""
The name of the object type that this automation applies to.
"""
# @ApiMember(Description="A guid list containing the selected system action Id's that trigger this automation.", ParameterType="query")
action_list: Optional[List[str]] = None
"""
A guid list containing the selected system action Id's that trigger this automation.
"""
# @ApiMember(Description="A comma separated string of the selected system action names that trigger this automation.", ParameterType="query")
actions: Optional[str] = None
"""
A comma separated string of the selected system action names that trigger this automation.
"""
# @ApiMember(Description="Name of the automation.", ParameterType="query")
name: Optional[str] = None
"""
Name of the automation.
"""
# @ApiMember(Description="Description of the automation", ParameterType="query")
description: Optional[str] = None
"""
Description of the automation
"""
# @ApiMember(Description="Owner Contact Id", ParameterType="query")
owner_contact_id: Optional[str] = None
"""
Owner Contact Id
"""
# @ApiMember(Description="Record Status of the automation.", ParameterType="query")
record_status: Optional[str] = None
"""
Record Status of the automation.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutoDocumentationModel(AutomationModel):
# @ApiMember(Description="Report Id", ParameterType="query")
report_id: Optional[str] = None
"""
Report Id
"""
# @ApiMember(Description="Report Name", ParameterType="query")
report: Optional[str] = None
"""
Report Name
"""
# @ApiMember(Description="Document Type Id", ParameterType="query")
document_type_id: Optional[str] = None
"""
Document Type Id
"""
# @ApiMember(Description="Document Type", ParameterType="query")
document_type: Optional[str] = None
"""
Document Type
"""
# @ApiMember(Description="Document Status Id", ParameterType="query")
document_status_id: Optional[str] = None
"""
Document Status Id
"""
# @ApiMember(Description="The Document Status", ParameterType="query")
document_status: Optional[str] = None
"""
The Document Status
"""
# @ApiResponse(Description="Returns a documentation automation")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentationAutomationResponse:
# @ApiMember(Description="Documentation Automation")
automation: Optional[AutoDocumentationModel] = None
"""
Documentation Automation
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get details of a specific documentation automation")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentationAutomation:
"""
Get details of a specific documentation automation
"""
# @ApiMember(Description="Automation Id.", ParameterType="path")
automation_id: Optional[str] = None
"""
Automation Id.
"""
Python GetDocumentationAutomation 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/{AutomationId}/documentation HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Automation:
{
Report: String,
DocumentType: String,
DocumentStatus: String,
AutomationType: String,
ObjectName: String,
RmsTableCtxName: String,
ActionList:
[
00000000-0000-0000-0000-000000000000
],
Actions: String,
Name: String,
Description: String,
RecordStatus: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}