| GET | /api/automation/systemactions/{AutomationTypeId} |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models
Namespace Global
Namespace Eros.Saguna.Common.WebAPIModel.Models
Public Partial Class ListItemModel
Public Overridable Property ListItemId As Guid
Public Overridable Property Name As String
Public Overridable Property Description As String
Public Overridable Property ShortName As String
Public Overridable Property IsDefault As Boolean
Public Overridable Property Order As Integer
Public Overridable Property ListItemTrafficLightId As Guid
Public Overridable Property PrimaryListItemImageId As Guid
Public Overridable Property PrimaryListItemImageUrl As String
Public Overridable Property PrimaryImageThumbnailUrl As String
Public Overridable Property OwnerContactId As Guid
Public Overridable Property RecordStatus As String
End Class
End Namespace
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 Overridable Property AutomationTypeId As Guid
'''<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 Overridable Property RmsTableCtxId As Guid
End Class
<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 Overridable Property SystemActions As List(Of ListItemModel)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET GetSystemActionsForAutomationType DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}