Platform API

<back to all web services

DeleteAutomation

Delete an automation (Any type).

Requires Authentication
The following routes are available for this service:
DELETE/api/automation/{AutomationId}

/** @description Delete an automation (Any type). */
// @Api(Description="Delete an automation (Any type).")
export class DeleteAutomation
{
    /** @description Id of the automation to be deleted. */
    // @ApiMember(Description="Id of the automation to be deleted.", ParameterType="path")
    public AutomationId: string;

    public constructor(init?: Partial<DeleteAutomation>) { (Object as any).assign(this, init); }
}

TypeScript DeleteAutomation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /api/automation/{AutomationId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	}
}