Platform API

<back to all web services

GetAutomationsForObject

Get automations that are setup for an object

import Foundation
import ServiceStack

/**
* Get automations that are setup for an object
*/
// @Api(Description="Get automations that are setup for an object")
public class GetAutomationsForObject : Codable
{
    /**
    * Object to retrieve automations for.
    */
    // @ApiMember(Description="Object to retrieve automations for.", ParameterType="path")
    public var objectId:String

    required public init(){}
}

// @ApiResponse(Description="List of automations that are setup for an object")
public class GetAutomationsForObjectResponse : Codable
{
    /**
    * List of automations.
    */
    // @ApiMember(Description="List of automations.")
    public var automations:[AutomationModel]

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class AutomationModel : Codable
{
    /**
    * The unique automation Id
    */
    // @ApiMember(Description="The unique automation Id", ParameterType="query")
    public var automationId:String

    /**
    * The automation type Id
    */
    // @ApiMember(Description="The automation type Id", ParameterType="query")
    public var automationTypeId:String

    /**
    * The automation type
    */
    // @ApiMember(Description="The automation type", ParameterType="query")
    public var automationType:String

    /**
    * The object this automation applies to
    */
    // @ApiMember(Description="The object this automation applies to", ParameterType="query")
    public var objectId:String

    /**
    * The object name this automation applies to
    */
    // @ApiMember(Description="The object name this automation applies to", ParameterType="query")
    public var objectName:String

    /**
    * The Id of the object type that this automation applies to. 
    */
    // @ApiMember(Description="The Id of the object type that this automation applies to. ", ParameterType="query")
    public var rmsTableCtxIdObject:String

    /**
    * The name of the object type that this automation applies to.
    */
    // @ApiMember(Description="The name of the object type that this automation applies to.", ParameterType="query")
    public var rmsTableCtxName:String

    /**
    * A guid list containing the selected system action Id's that trigger this automation.
    */
    // @ApiMember(Description="A guid list containing the selected system action Id's that trigger this automation.", ParameterType="query")
    public var actionList:[String]

    /**
    * A comma separated string of the selected system action names that trigger this automation.
    */
    // @ApiMember(Description="A comma separated string of the selected system action names that trigger this automation.", ParameterType="query")
    public var actions:String

    /**
    * Name of the automation.
    */
    // @ApiMember(Description="Name of the automation.", ParameterType="query")
    public var name:String

    /**
    * Description of the automation
    */
    // @ApiMember(Description="Description of the automation", ParameterType="query")
    public var Description:String

    /**
    * Owner Contact Id
    */
    // @ApiMember(Description="Owner Contact Id", ParameterType="query")
    public var ownerContactId:String

    /**
    * Record Status of the automation.
    */
    // @ApiMember(Description="Record Status of the automation.", ParameterType="query")
    public var recordStatus:String

    required public init(){}
}

Swift GetAutomationsForObject DTOs

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>