Platform API

<back to all web services

GetDocumentationAutomation

Get details of a specific documentation automation

import Foundation
import ServiceStack

/**
* Get details of a specific documentation automation
*/
// @Api(Description="Get details of a specific documentation automation")
public class GetDocumentationAutomation : Codable
{
    /**
    * Automation Id.
    */
    // @ApiMember(Description="Automation Id.", ParameterType="path")
    public var automationId:String

    required public init(){}
}

// @ApiResponse(Description="Returns a documentation automation")
public class GetDocumentationAutomationResponse : Codable
{
    /**
    * Documentation Automation
    */
    // @ApiMember(Description="Documentation Automation")
    public var automation:AutoDocumentationModel

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class AutoDocumentationModel : AutomationModel
{
    /**
    * Report Id
    */
    // @ApiMember(Description="Report Id", ParameterType="query")
    public var reportId:String

    /**
    * Report Name
    */
    // @ApiMember(Description="Report Name", ParameterType="query")
    public var report:String

    /**
    * Document Type Id
    */
    // @ApiMember(Description="Document Type Id", ParameterType="query")
    public var documentTypeId:String

    /**
    * Document Type
    */
    // @ApiMember(Description="Document Type", ParameterType="query")
    public var documentType:String

    /**
    * Document Status Id
    */
    // @ApiMember(Description="Document Status Id", ParameterType="query")
    public var documentStatusId:String

    /**
    * The Document Status
    */
    // @ApiMember(Description="The Document Status", ParameterType="query")
    public var documentStatus:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case reportId
        case report
        case documentTypeId
        case documentType
        case documentStatusId
        case documentStatus
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        reportId = try container.decodeIfPresent(String.self, forKey: .reportId)
        report = try container.decodeIfPresent(String.self, forKey: .report)
        documentTypeId = try container.decodeIfPresent(String.self, forKey: .documentTypeId)
        documentType = try container.decodeIfPresent(String.self, forKey: .documentType)
        documentStatusId = try container.decodeIfPresent(String.self, forKey: .documentStatusId)
        documentStatus = try container.decodeIfPresent(String.self, forKey: .documentStatus)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if reportId != nil { try container.encode(reportId, forKey: .reportId) }
        if report != nil { try container.encode(report, forKey: .report) }
        if documentTypeId != nil { try container.encode(documentTypeId, forKey: .documentTypeId) }
        if documentType != nil { try container.encode(documentType, forKey: .documentType) }
        if documentStatusId != nil { try container.encode(documentStatusId, forKey: .documentStatusId) }
        if documentStatus != nil { try container.encode(documentStatus, forKey: .documentStatus) }
    }
}

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 GetDocumentationAutomation DTOs

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

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

{
	Automation: 
	{
		Report: String,
		DocumentType: String,
		DocumentStatus: String,
		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
		}
	}
}