| All Verbs | /api/component/{ApplianceComponentId}/help/ |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get all help content for the specified UI Appliance Component
*/
@Api(Description="Get all help content for the specified UI Appliance Component")
open class GetApplianceComponentHelp
{
/**
* Appliance Component Id to retrieve help for.
*/
@ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
open var ApplianceComponentId:UUID? = null
}
@ApiResponse(Description="A list of help content")
open class GetApplianceComponentHelpResponse
{
/**
* List of help content.
*/
@ApiMember(Description="List of help content.", ParameterType="query")
open var HelpContent:ArrayList<HelpContentModel>? = null
/**
* Response Status
*/
@ApiMember(Description="Response Status", ParameterType="query")
open var ResponseStatus:ResponseStatus? = null
}
open class HelpContentModel
{
/**
* Content Name - Can be used as a heading/title.
*/
@ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")
open var Name:String? = null
/**
* URL containing the help notes. This will either be a web page or a html blob file containing the information.
*/
@ApiMember(Description="URL containing the help notes. This will either be a web page or a html blob file containing the information.", ParameterType="query")
open var URL:String? = null
/**
* 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, 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")
open var IsSnippet:Boolean? = null
/**
* If true, this content is for external client/users. False means it is a developer note.
*/
@ApiMember(Description="If true, this content is for external client/users. False means it is a developer note.", ParameterType="query")
open var IsUserFacing:Boolean? = null
/**
* If you have multiple snippets, this is an order you should display them in.
*/
@ApiMember(Description="If you have multiple snippets, this is an order you should display them in.", ParameterType="query")
open var Index:Int? = null
/**
* This is the document status of the help content. It will be either draft or final.
*/
@ApiMember(Description="This is the document status of the help content. It will be either draft or final.", ParameterType="query")
open var StatusId:UUID? = null
}
Kotlin 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
}
}
}