| All Verbs | /api/component/{ApplianceComponentId}/help/ |
|---|
"use strict";
export class HelpContentModel {
/** @param {{Name?:string,URL?:string,IsSnippet?:boolean,IsUserFacing?:boolean,Index?:number,StatusId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Content Name - Can be used as a heading/title. */
Name;
/**
* @type {string}
* @description URL containing the help notes. This will either be a web page or a html blob file containing the information. */
URL;
/**
* @type {boolean}
* @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. */
IsSnippet;
/**
* @type {boolean}
* @description If true, this content is for external client/users. False means it is a developer note. */
IsUserFacing;
/**
* @type {number}
* @description If you have multiple snippets, this is an order you should display them in. */
Index;
/**
* @type {string}
* @description This is the document status of the help content. It will be either draft or final. */
StatusId;
}
export class GetApplianceComponentHelpResponse {
/** @param {{HelpContent?:HelpContentModel[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {HelpContentModel[]}
* @description List of help content. */
HelpContent;
/**
* @type {ResponseStatus}
* @description Response Status */
ResponseStatus;
}
export class GetApplianceComponentHelp {
/** @param {{ApplianceComponentId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Appliance Component Id to retrieve help for. */
ApplianceComponentId;
}
JavaScript GetApplianceComponentHelp DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ApplianceComponentId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"HelpContent":[{"Name":"String","URL":"String","IsSnippet":false,"IsUserFacing":false,"Index":0,"StatusId":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}