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}

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 automation types available for the specified object type (rmsTableCtxId)
    ///</summary>
    [Api(Description="Get automation types available for the specified object type (rmsTableCtxId)")]
    public partial class GetAutomationTypesByObjectType
    {
        ///<summary>
        ///RmsTableCtx Id to filter available automation types by
        ///</summary>
        [ApiMember(Description="RmsTableCtx Id to filter available automation types by", ParameterType="path")]
        public virtual Guid RmsTableCtxId { get; set; }
    }

    [ApiResponse(Description="A list of automation types assignable to a particular object type")]
    public partial class GetAutomationTypesByObjectTypeResponse
    {
        ///<summary>
        ///List of applicable automation types.
        ///</summary>
        [ApiMember(Description="List of applicable automation types.")]
        public virtual List<ListItemModel> AutomationTypes { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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

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

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