Platform API

<back to all web services

GetAutomationsForObject

Get automations that are setup for an object

import 'package:servicestack/servicestack.dart';

class AutomationModel implements IConvertible
{
    /**
    * The unique automation Id
    */
    // @ApiMember(Description="The unique automation Id", ParameterType="query")
    String? AutomationId;

    /**
    * The automation type Id
    */
    // @ApiMember(Description="The automation type Id", ParameterType="query")
    String? AutomationTypeId;

    /**
    * The automation type
    */
    // @ApiMember(Description="The automation type", ParameterType="query")
    String? AutomationType;

    /**
    * The object this automation applies to
    */
    // @ApiMember(Description="The object this automation applies to", ParameterType="query")
    String? ObjectId;

    /**
    * The object name this automation applies to
    */
    // @ApiMember(Description="The object name this automation applies to", ParameterType="query")
    String? ObjectName;

    /**
    * 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")
    String? RmsTableCtxIdObject;

    /**
    * 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")
    String? RmsTableCtxName;

    /**
    * 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")
    List<String>? ActionList;

    /**
    * 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")
    String? Actions;

    /**
    * Name of the automation.
    */
    // @ApiMember(Description="Name of the automation.", ParameterType="query")
    String? Name;

    /**
    * Description of the automation
    */
    // @ApiMember(Description="Description of the automation", ParameterType="query")
    String? Description;

    /**
    * Owner Contact Id
    */
    // @ApiMember(Description="Owner Contact Id", ParameterType="query")
    String? OwnerContactId;

    /**
    * Record Status of the automation.
    */
    // @ApiMember(Description="Record Status of the automation.", ParameterType="query")
    String? RecordStatus;

    AutomationModel({this.AutomationId,this.AutomationTypeId,this.AutomationType,this.ObjectId,this.ObjectName,this.RmsTableCtxIdObject,this.RmsTableCtxName,this.ActionList,this.Actions,this.Name,this.Description,this.OwnerContactId,this.RecordStatus});
    AutomationModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AutomationId = json['AutomationId'];
        AutomationTypeId = json['AutomationTypeId'];
        AutomationType = json['AutomationType'];
        ObjectId = json['ObjectId'];
        ObjectName = json['ObjectName'];
        RmsTableCtxIdObject = json['RmsTableCtxIdObject'];
        RmsTableCtxName = json['RmsTableCtxName'];
        ActionList = JsonConverters.fromJson(json['ActionList'],'List<String>',context!);
        Actions = json['Actions'];
        Name = json['Name'];
        Description = json['Description'];
        OwnerContactId = json['OwnerContactId'];
        RecordStatus = json['RecordStatus'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AutomationId': AutomationId,
        'AutomationTypeId': AutomationTypeId,
        'AutomationType': AutomationType,
        'ObjectId': ObjectId,
        'ObjectName': ObjectName,
        'RmsTableCtxIdObject': RmsTableCtxIdObject,
        'RmsTableCtxName': RmsTableCtxName,
        'ActionList': JsonConverters.toJson(ActionList,'List<String>',context!),
        'Actions': Actions,
        'Name': Name,
        'Description': Description,
        'OwnerContactId': OwnerContactId,
        'RecordStatus': RecordStatus
    };

    getTypeName() => "AutomationModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="List of automations that are setup for an object")
class GetAutomationsForObjectResponse implements IConvertible
{
    /**
    * List of automations.
    */
    // @ApiMember(Description="List of automations.")
    List<AutomationModel>? Automations;

    ResponseStatus? ResponseStatus;

    GetAutomationsForObjectResponse({this.Automations,this.ResponseStatus});
    GetAutomationsForObjectResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Automations = JsonConverters.fromJson(json['Automations'],'List<AutomationModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Automations': JsonConverters.toJson(Automations,'List<AutomationModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetAutomationsForObjectResponse";
    TypeContext? context = _ctx;
}

/**
* Get automations that are setup for an object
*/
// @Api(Description="Get automations that are setup for an object")
class GetAutomationsForObject implements IConvertible
{
    /**
    * Object to retrieve automations for.
    */
    // @ApiMember(Description="Object to retrieve automations for.", ParameterType="path")
    String? ObjectId;

    GetAutomationsForObject({this.ObjectId});
    GetAutomationsForObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectId = json['ObjectId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectId': ObjectId
    };

    getTypeName() => "GetAutomationsForObject";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'AutomationModel': TypeInfo(TypeOf.Class, create:() => AutomationModel()),
    'GetAutomationsForObjectResponse': TypeInfo(TypeOf.Class, create:() => GetAutomationsForObjectResponse()),
    'List<AutomationModel>': TypeInfo(TypeOf.Class, create:() => <AutomationModel>[]),
    'GetAutomationsForObject': TypeInfo(TypeOf.Class, create:() => GetAutomationsForObject()),
});

Dart GetAutomationsForObject DTOs

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
		}
	}
}