| GET | /api/automation/{ObjectId}/list |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get automations that are setup for an object
*/
@Api(Description="Get automations that are setup for an object")
open class GetAutomationsForObject
{
/**
* Object to retrieve automations for.
*/
@ApiMember(Description="Object to retrieve automations for.", ParameterType="path")
open var ObjectId:UUID? = null
}
@ApiResponse(Description="List of automations that are setup for an object")
open class GetAutomationsForObjectResponse
{
/**
* List of automations.
*/
@ApiMember(Description="List of automations.")
open var Automations:ArrayList<AutomationModel>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class AutomationModel
{
/**
* The unique automation Id
*/
@ApiMember(Description="The unique automation Id", ParameterType="query")
open var AutomationId:UUID? = null
/**
* The automation type Id
*/
@ApiMember(Description="The automation type Id", ParameterType="query")
open var AutomationTypeId:UUID? = null
/**
* The automation type
*/
@ApiMember(Description="The automation type", ParameterType="query")
open var AutomationType:String? = null
/**
* The object this automation applies to
*/
@ApiMember(Description="The object this automation applies to", ParameterType="query")
open var ObjectId:UUID? = null
/**
* The object name this automation applies to
*/
@ApiMember(Description="The object name this automation applies to", ParameterType="query")
open var ObjectName:String? = null
/**
* 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")
open var RmsTableCtxIdObject:UUID? = null
/**
* 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")
open var RmsTableCtxName:String? = null
/**
* 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")
open var ActionList:ArrayList<UUID>? = null
/**
* 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")
open var Actions:String? = null
/**
* Name of the automation.
*/
@ApiMember(Description="Name of the automation.", ParameterType="query")
open var Name:String? = null
/**
* Description of the automation
*/
@ApiMember(Description="Description of the automation", ParameterType="query")
open var Description:String? = null
/**
* Owner Contact Id
*/
@ApiMember(Description="Owner Contact Id", ParameterType="query")
open var OwnerContactId:UUID? = null
/**
* Record Status of the automation.
*/
@ApiMember(Description="Record Status of the automation.", ParameterType="query")
open var RecordStatus:String? = null
}
Kotlin GetAutomationsForObject 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/{ObjectId}/list HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Automations":[{"AutomationId":"00000000-0000-0000-0000-000000000000","AutomationTypeId":"00000000-0000-0000-0000-000000000000","AutomationType":"String","ObjectId":"00000000-0000-0000-0000-000000000000","ObjectName":"String","RmsTableCtxIdObject":"00000000-0000-0000-0000-000000000000","RmsTableCtxName":"String","ActionList":["00000000-0000-0000-0000-000000000000"],"Actions":"String","Name":"String","Description":"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"}}}