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}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get automation types available for the specified object type (rmsTableCtxId)
*/
@Api(Description="Get automation types available for the specified object type (rmsTableCtxId)")
open class GetAutomationTypesByObjectType
{
    /**
    * RmsTableCtx Id to filter available automation types by
    */
    @ApiMember(Description="RmsTableCtx Id to filter available automation types by", ParameterType="path")
    open var RmsTableCtxId:UUID? = null
}

@ApiResponse(Description="A list of automation types assignable to a particular object type")
open class GetAutomationTypesByObjectTypeResponse
{
    /**
    * List of applicable automation types.
    */
    @ApiMember(Description="List of applicable automation types.")
    open var AutomationTypes:ArrayList<ListItemModel>? = null

    open var ResponseStatus:ResponseStatus? = null
}

open class ListItemModel
{
    open var ListItemId:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ShortName:String? = null
    open var IsDefault:Boolean? = null
    open var Order:Int? = null
    open var ListItemTrafficLightId:UUID? = null
    open var PrimaryListItemImageId:UUID? = null
    open var PrimaryListItemImageUrl:String? = null
    open var PrimaryImageThumbnailUrl:String? = null
    open var OwnerContactId:UUID? = null
    open var RecordStatus:String? = null
}

Kotlin GetAutomationTypesByObjectType 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/availabletypes/{RmsTableCtxId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json

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