Platform API

GetSystemActionsForAutomationType

Get system actions for the specified automation type

The following routes are available for this service:
GET	/api/automation/systemactions/{AutomationTypeId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get system actions for the specified automation type
*/
@Api(Description="Get system actions for the specified automation type")
open class GetSystemActionsForAutomationType
{
    /**
    * Automation Type Id to get the system actions for.
    */
    @ApiMember(Description="Automation Type Id to get the system actions for.", ParameterType="path")
    open var AutomationTypeId:UUID? = null

    /**
    * RmsTableCtx Id of the object type the automation is for. System Actions can change based on the type they apply to.
    */
    @ApiMember(Description="RmsTableCtx Id of the object type the automation is for. System Actions can change based on the type they apply to.", ParameterType="path")
    open var RmsTableCtxId:UUID? = null
}

@ApiResponse(Description="A list of system actions that can be used with a specified automation type")
open class GetSystemActionsForAutomationTypeResponse
{
    /**
    * List of applicable system actions.
    */
    @ApiMember(Description="List of applicable system actions.")
    open var SystemActions:ArrayList<ListItemModel>? = null

    open var ResponseStatus:ResponseStatus? = null
}

open class ListItemModel
{
    open var ListItemId:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ShortName:String? = null
    open var IsDefault:Boolean? = null
    open var Order:Int? = null
    open var ListItemTrafficLightId:UUID? = null
    open var PrimaryListItemImageId:UUID? = null
    open var PrimaryListItemImageUrl:String? = null
    open var PrimaryImageThumbnailUrl:String? = null
    open var OwnerContactId:UUID? = null
    open var RecordStatus:String? = null
}

Kotlin GetSystemActionsForAutomationType DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/automation/systemactions/{AutomationTypeId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"SystemActions":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}