| GET | /api/automation/{ObjectId}/list |
|---|
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Automations:
[
{
AutomationType: String,
ObjectName: String,
RmsTableCtxName: String,
ActionList:
[
00000000-0000-0000-0000-000000000000
],
Actions: String,
Name: String,
Description: String,
RecordStatus: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}