Platform API

<back to all web services

GetAutomationsForObject

Get automations that are setup for an object

Requires Authentication
The following routes are available for this service:
GET/api/automation/{ObjectId}/list
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 AutomationModel
            '''<Summary>
            '''The unique automation Id
            '''</Summary>
            <ApiMember(Description:="The unique automation Id", ParameterType:="query")>
            Public Overridable Property AutomationId As Guid

            '''<Summary>
            '''The automation type Id
            '''</Summary>
            <ApiMember(Description:="The automation type Id", ParameterType:="query")>
            Public Overridable Property AutomationTypeId As Guid

            '''<Summary>
            '''The automation type
            '''</Summary>
            <ApiMember(Description:="The automation type", ParameterType:="query")>
            Public Overridable Property AutomationType As String

            '''<Summary>
            '''The object this automation applies to
            '''</Summary>
            <ApiMember(Description:="The object this automation applies to", ParameterType:="query")>
            Public Overridable Property ObjectId As Guid

            '''<Summary>
            '''The object name this automation applies to
            '''</Summary>
            <ApiMember(Description:="The object name this automation applies to", ParameterType:="query")>
            Public Overridable Property ObjectName As String

            '''<Summary>
            '''The Id of the object type that this automation applies to. 
            '''</Summary>
            <ApiMember(Description:="The Id of the object type that this automation applies to. ", ParameterType:="query")>
            Public Overridable Property RmsTableCtxIdObject As Guid

            '''<Summary>
            '''The name of the object type that this automation applies to.
            '''</Summary>
            <ApiMember(Description:="The name of the object type that this automation applies to.", ParameterType:="query")>
            Public Overridable Property RmsTableCtxName As String

            '''<Summary>
            '''A guid list containing the selected system action Id's that trigger this automation.
            '''</Summary>
            <ApiMember(Description:="A guid list containing the selected system action Id's that trigger this automation.", ParameterType:="query")>
            Public Overridable Property ActionList As List(Of Guid)

            '''<Summary>
            '''A comma separated string of the selected system action names that trigger this automation.
            '''</Summary>
            <ApiMember(Description:="A comma separated string of the selected system action names that trigger this automation.", ParameterType:="query")>
            Public Overridable Property Actions As String

            '''<Summary>
            '''Name of the automation.
            '''</Summary>
            <ApiMember(Description:="Name of the automation.", ParameterType:="query")>
            Public Overridable Property Name As String

            '''<Summary>
            '''Description of the automation
            '''</Summary>
            <ApiMember(Description:="Description of the automation", ParameterType:="query")>
            Public Overridable Property Description As String

            '''<Summary>
            '''Owner Contact Id
            '''</Summary>
            <ApiMember(Description:="Owner Contact Id", ParameterType:="query")>
            Public Overridable Property OwnerContactId As Guid

            '''<Summary>
            '''Record Status of the automation.
            '''</Summary>
            <ApiMember(Description:="Record Status of the automation.", ParameterType:="query")>
            Public Overridable Property RecordStatus As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get automations that are setup for an object
        '''</Summary>
        <Api(Description:="Get automations that are setup for an object")>
        Public Partial Class GetAutomationsForObject
            '''<Summary>
            '''Object to retrieve automations for.
            '''</Summary>
            <ApiMember(Description:="Object to retrieve automations for.", ParameterType:="path")>
            Public Overridable Property ObjectId As Guid
        End Class

        <ApiResponse(Description:="List of automations that are setup for an object")>
        Public Partial Class GetAutomationsForObjectResponse
            '''<Summary>
            '''List of automations.
            '''</Summary>
            <ApiMember(Description:="List of automations.")>
            Public Overridable Property Automations As List(Of AutomationModel)

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetAutomationsForObject DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/automation/{ObjectId}/list HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAutomationsForObjectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Automations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:AutomationModel>
      <d2p1:ActionList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </d2p1:ActionList>
      <d2p1:Actions>String</d2p1:Actions>
      <d2p1:AutomationId>00000000-0000-0000-0000-000000000000</d2p1:AutomationId>
      <d2p1:AutomationType>String</d2p1:AutomationType>
      <d2p1:AutomationTypeId>00000000-0000-0000-0000-000000000000</d2p1:AutomationTypeId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
      <d2p1:ObjectName>String</d2p1:ObjectName>
      <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:RmsTableCtxIdObject>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxIdObject>
      <d2p1:RmsTableCtxName>String</d2p1:RmsTableCtxName>
    </d2p1:AutomationModel>
  </Automations>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetAutomationsForObjectResponse>