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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get system actions for the specified automation type
    */
    @Api(Description="Get system actions for the specified automation type")
    public static class GetSystemActionsForAutomationType
    {
        /**
        * Automation Type Id to get the system actions for.
        */
        @ApiMember(Description="Automation Type Id to get the system actions for.", ParameterType="path")
        public UUID AutomationTypeId = 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")
        public UUID RmsTableCtxId = null;
        
        public UUID getAutomationTypeId() { return AutomationTypeId; }
        public GetSystemActionsForAutomationType setAutomationTypeId(UUID value) { this.AutomationTypeId = value; return this; }
        public UUID getRmsTableCtxId() { return RmsTableCtxId; }
        public GetSystemActionsForAutomationType setRmsTableCtxId(UUID value) { this.RmsTableCtxId = value; return this; }
    }

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

        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ListItemModel> getSystemActions() { return SystemActions; }
        public GetSystemActionsForAutomationTypeResponse setSystemActions(ArrayList<ListItemModel> value) { this.SystemActions = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetSystemActionsForAutomationTypeResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ListItemModel
    {
        public UUID ListItemId = null;
        public String Name = null;
        public String Description = null;
        public String ShortName = null;
        public Boolean IsDefault = null;
        public Integer Order = null;
        public UUID ListItemTrafficLightId = null;
        public UUID PrimaryListItemImageId = null;
        public String PrimaryListItemImageUrl = null;
        public String PrimaryImageThumbnailUrl = null;
        public UUID OwnerContactId = null;
        public String RecordStatus = null;
        
        public UUID getListItemId() { return ListItemId; }
        public ListItemModel setListItemId(UUID value) { this.ListItemId = value; return this; }
        public String getName() { return Name; }
        public ListItemModel setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ListItemModel setDescription(String value) { this.Description = value; return this; }
        public String getShortName() { return ShortName; }
        public ListItemModel setShortName(String value) { this.ShortName = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public ListItemModel setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public Integer getOrder() { return Order; }
        public ListItemModel setOrder(Integer value) { this.Order = value; return this; }
        public UUID getListItemTrafficLightId() { return ListItemTrafficLightId; }
        public ListItemModel setListItemTrafficLightId(UUID value) { this.ListItemTrafficLightId = value; return this; }
        public UUID getPrimaryListItemImageId() { return PrimaryListItemImageId; }
        public ListItemModel setPrimaryListItemImageId(UUID value) { this.PrimaryListItemImageId = value; return this; }
        public String getPrimaryListItemImageUrl() { return PrimaryListItemImageUrl; }
        public ListItemModel setPrimaryListItemImageUrl(String value) { this.PrimaryListItemImageUrl = value; return this; }
        public String getPrimaryImageThumbnailUrl() { return PrimaryImageThumbnailUrl; }
        public ListItemModel setPrimaryImageThumbnailUrl(String value) { this.PrimaryImageThumbnailUrl = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public ListItemModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ListItemModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

}

Java GetSystemActionsForAutomationType DTOs

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

HTTP + OTHER

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