| GET | /api/automation/availabletypes/{RmsTableCtxId} |
|---|
export class ListItemModel
{
public ListItemId: string;
public Name: string;
public Description: string;
public ShortName: string;
public IsDefault: boolean;
public Order: number;
public ListItemTrafficLightId: string;
public PrimaryListItemImageId: string;
public PrimaryListItemImageUrl: string;
public PrimaryImageThumbnailUrl: string;
public OwnerContactId: string;
public RecordStatus: string;
public constructor(init?: Partial<ListItemModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="A list of automation types assignable to a particular object type")
export class GetAutomationTypesByObjectTypeResponse
{
/** @description List of applicable automation types. */
// @ApiMember(Description="List of applicable automation types.")
public AutomationTypes: ListItemModel[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetAutomationTypesByObjectTypeResponse>) { (Object as any).assign(this, init); }
}
/** @description Get automation types available for the specified object type (rmsTableCtxId) */
// @Api(Description="Get automation types available for the specified object type (rmsTableCtxId)")
export class GetAutomationTypesByObjectType
{
/** @description RmsTableCtx Id to filter available automation types by */
// @ApiMember(Description="RmsTableCtx Id to filter available automation types by", ParameterType="path")
public RmsTableCtxId: string;
public constructor(init?: Partial<GetAutomationTypesByObjectType>) { (Object as any).assign(this, init); }
}
TypeScript GetAutomationTypesByObjectType 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/availabletypes/{RmsTableCtxId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
AutomationTypes:
[
{
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
}
}
}