Platform API

GetSystemActionsForAutomationType

Get system actions for the specified automation type

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

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ListItemModel() = 
        member val ListItemId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val ShortName:String = null with get,set
        member val IsDefault:Boolean = new Boolean() with get,set
        member val Order:Int32 = new Int32() with get,set
        member val ListItemTrafficLightId:Guid = new Guid() with get,set
        member val PrimaryListItemImageId:Guid = new Guid() with get,set
        member val PrimaryListItemImageUrl:String = null with get,set
        member val PrimaryImageThumbnailUrl:String = null with get,set
        member val OwnerContactId:Guid = new Guid() with get,set
        member val RecordStatus:String = null with get,set

    [<ApiResponse(Description="A list of system actions that can be used with a specified automation type")>]
    [<AllowNullLiteral>]
    type GetSystemActionsForAutomationTypeResponse() = 
        ///<summary>
        ///List of applicable system actions.
        ///</summary>
        [<ApiMember(Description="List of applicable system actions.")>]
        member val SystemActions:ResizeArray<ListItemModel> = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get system actions for the specified automation type
    ///</summary>
    [<Api(Description="Get system actions for the specified automation type")>]
    [<AllowNullLiteral>]
    type GetSystemActionsForAutomationType() = 
        ///<summary>
        ///Automation Type Id to get the system actions for.
        ///</summary>
        [<ApiMember(Description="Automation Type Id to get the system actions for.", ParameterType="path")>]
        member val AutomationTypeId:Guid = new Guid() with get,set

        ///<summary>
        ///RmsTableCtx Id of the object type the automation is for. System Actions can change based on the type they apply to.
        ///</summary>
        [<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")>]
        member val RmsTableCtxId:Guid = new Guid() with get,set

F# GetSystemActionsForAutomationType DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}