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
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 AutomationModel() = 
        ///<summary>
        ///The unique automation Id
        ///</summary>
        [<ApiMember(Description="The unique automation Id", ParameterType="query")>]
        member val AutomationId:Guid = new Guid() with get,set

        ///<summary>
        ///The automation type Id
        ///</summary>
        [<ApiMember(Description="The automation type Id", ParameterType="query")>]
        member val AutomationTypeId:Guid = new Guid() with get,set

        ///<summary>
        ///The automation type
        ///</summary>
        [<ApiMember(Description="The automation type", ParameterType="query")>]
        member val AutomationType:String = null with get,set

        ///<summary>
        ///The object this automation applies to
        ///</summary>
        [<ApiMember(Description="The object this automation applies to", ParameterType="query")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///The object name this automation applies to
        ///</summary>
        [<ApiMember(Description="The object name this automation applies to", ParameterType="query")>]
        member val ObjectName:String = null with get,set

        ///<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")>]
        member val RmsTableCtxIdObject:Guid = new Guid() with get,set

        ///<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")>]
        member val RmsTableCtxName:String = null with get,set

        ///<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")>]
        member val ActionList:ResizeArray<Guid> = null with get,set

        ///<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")>]
        member val Actions:String = null with get,set

        ///<summary>
        ///Name of the automation.
        ///</summary>
        [<ApiMember(Description="Name of the automation.", ParameterType="query")>]
        member val Name:String = null with get,set

        ///<summary>
        ///Description of the automation
        ///</summary>
        [<ApiMember(Description="Description of the automation", ParameterType="query")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Owner Contact Id
        ///</summary>
        [<ApiMember(Description="Owner Contact Id", ParameterType="query")>]
        member val OwnerContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Record Status of the automation.
        ///</summary>
        [<ApiMember(Description="Record Status of the automation.", ParameterType="query")>]
        member val RecordStatus:String = null with get,set

    [<ApiResponse(Description="List of automations that are setup for an object")>]
    [<AllowNullLiteral>]
    type GetAutomationsForObjectResponse() = 
        ///<summary>
        ///List of automations.
        ///</summary>
        [<ApiMember(Description="List of automations.")>]
        member val Automations:ResizeArray<AutomationModel> = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get automations that are setup for an object
    ///</summary>
    [<Api(Description="Get automations that are setup for an object")>]
    [<AllowNullLiteral>]
    type GetAutomationsForObject() = 
        ///<summary>
        ///Object to retrieve automations for.
        ///</summary>
        [<ApiMember(Description="Object to retrieve automations for.", ParameterType="path")>]
        member val ObjectId:Guid = new Guid() with get,set

F# 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>