| All Verbs | /api/component/{ApplianceComponentId}/help/ |
|---|
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 HelpContentModel:
# @ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")
name: Optional[str] = None
"""
Content Name - Can be used as a heading/title.
"""
# @ApiMember(Description="URL containing the help notes. This will either be a web page or a html blob file containing the information.", ParameterType="query")
url: Optional[str] = None
"""
URL containing the help notes. This will either be a web page or a html blob file containing the information.
"""
# @ApiMember(Description="If true, the URL is a blob file and details should be shown in a pop up or tooltip, if false, this is a full URL to a web page and should be opened in a new tab.", ParameterType="query")
is_snippet: bool = False
"""
If true, the URL is a blob file and details should be shown in a pop up or tooltip, if false, this is a full URL to a web page and should be opened in a new tab.
"""
# @ApiMember(Description="If true, this content is for external client/users. False means it is a developer note.", ParameterType="query")
is_user_facing: bool = False
"""
If true, this content is for external client/users. False means it is a developer note.
"""
# @ApiMember(Description="If you have multiple snippets, this is an order you should display them in.", ParameterType="query")
index: int = 0
"""
If you have multiple snippets, this is an order you should display them in.
"""
# @ApiMember(Description="This is the document status of the help content. It will be either draft or final.", ParameterType="query")
status_id: Optional[str] = None
"""
This is the document status of the help content. It will be either draft or final.
"""
# @ApiResponse(Description="A list of help content")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetApplianceComponentHelpResponse:
# @ApiMember(Description="List of help content.", ParameterType="query")
help_content: Optional[List[HelpContentModel]] = None
"""
List of help content.
"""
# @ApiMember(Description="Response Status", ParameterType="query")
response_status: Optional[ResponseStatus] = None
"""
Response Status
"""
# @Api(Description="Get all help content for the specified UI Appliance Component")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetApplianceComponentHelp:
"""
Get all help content for the specified UI Appliance Component
"""
# @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
appliance_component_id: Optional[str] = None
"""
Appliance Component Id to retrieve help for.
"""
Python GetApplianceComponentHelp 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.
POST /api/component/{ApplianceComponentId}/help/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
HelpContent:
[
{
Name: String,
URL: String,
IsSnippet: False,
IsUserFacing: False,
Index: 0
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}