Platform API

<back to all web services

GetSystemActionsForAutomationType

Get system actions for the specified automation type

Requires Authentication
The following routes are available for this service:
GET/api/automation/systemactions/{AutomationTypeId}
import Foundation
import ServiceStack

/**
* Get system actions for the specified automation type
*/
// @Api(Description="Get system actions for the specified automation type")
public class GetSystemActionsForAutomationType : Codable
{
    /**
    * Automation Type Id to get the system actions for.
    */
    // @ApiMember(Description="Automation Type Id to get the system actions for.", ParameterType="path")
    public var automationTypeId:String

    /**
    * 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")
    public var rmsTableCtxId:String

    required public init(){}
}

// @ApiResponse(Description="A list of system actions that can be used with a specified automation type")
public class GetSystemActionsForAutomationTypeResponse : Codable
{
    /**
    * List of applicable system actions.
    */
    // @ApiMember(Description="List of applicable system actions.")
    public var systemActions:[ListItemModel]

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ListItemModel : Codable
{
    public var listItemId:String
    public var name:String
    public var Description:String
    public var shortName:String
    public var isDefault:Bool
    public var order:Int
    public var listItemTrafficLightId:String
    public var primaryListItemImageId:String
    public var primaryListItemImageUrl:String
    public var primaryImageThumbnailUrl:String
    public var ownerContactId:String
    public var recordStatus:String

    required public init(){}
}


Swift 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"}}}