Platform API

GetAutomationTypesByObjectType

Get automation types available for the specified object type (rmsTableCtxId)

The following routes are available for this service:
GET	/api/automation/availabletypes/{RmsTableCtxId}

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 automation types assignable to a particular object type")>]
    [<AllowNullLiteral>]
    type GetAutomationTypesByObjectTypeResponse() = 
        ///<summary>
        ///List of applicable automation types.
        ///</summary>
        [<ApiMember(Description="List of applicable automation types.")>]
        member val AutomationTypes:ResizeArray<ListItemModel> = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get automation types available for the specified object type (rmsTableCtxId)
    ///</summary>
    [<Api(Description="Get automation types available for the specified object type (rmsTableCtxId)")>]
    [<AllowNullLiteral>]
    type GetAutomationTypesByObjectType() = 
        ///<summary>
        ///RmsTableCtx Id to filter available automation types by
        ///</summary>
        [<ApiMember(Description="RmsTableCtx Id to filter available automation types by", ParameterType="path")>]
        member val RmsTableCtxId:Guid = new Guid() with get,set

F# GetAutomationTypesByObjectType 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/availabletypes/{RmsTableCtxId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv

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

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