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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class ListItemModel
    {
        public virtual Guid ListItemId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string ShortName { get; set; }
        public virtual bool IsDefault { get; set; }
        public virtual int Order { get; set; }
        public virtual Guid ListItemTrafficLightId { get; set; }
        public virtual Guid PrimaryListItemImageId { get; set; }
        public virtual string PrimaryListItemImageUrl { get; set; }
        public virtual string PrimaryImageThumbnailUrl { get; set; }
        public virtual Guid OwnerContactId { get; set; }
        public virtual string RecordStatus { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get system actions for the specified automation type
    ///</summary>
    [Api(Description="Get system actions for the specified automation type")]
    public partial class 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")]
        public virtual Guid AutomationTypeId { 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")]
        public virtual Guid RmsTableCtxId { get; set; }
    }

    [ApiResponse(Description="A list of system actions that can be used with a specified automation type")]
    public partial class GetSystemActionsForAutomationTypeResponse
    {
        ///<summary>
        ///List of applicable system actions.
        ///</summary>
        [ApiMember(Description="List of applicable system actions.")]
        public virtual List<ListItemModel> SystemActions { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetSystemActionsForAutomationType DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SystemActions: 
	[
		{
			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
		}
	}
}