Platform API

<back to all web services

GetDocumentationAutomation

Get details of a specific documentation automation

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class AutoDocumentationModel
        : AutomationModel
    {
        ///<summary>
        ///Report Id
        ///</summary>
        [ApiMember(Description="Report Id", ParameterType="query")]
        public virtual Guid ReportId { get; set; }

        ///<summary>
        ///Report Name
        ///</summary>
        [ApiMember(Description="Report Name", ParameterType="query")]
        public virtual string Report { get; set; }

        ///<summary>
        ///Document Type Id
        ///</summary>
        [ApiMember(Description="Document Type Id", ParameterType="query")]
        public virtual Guid DocumentTypeId { get; set; }

        ///<summary>
        ///Document Type
        ///</summary>
        [ApiMember(Description="Document Type", ParameterType="query")]
        public virtual string DocumentType { get; set; }

        ///<summary>
        ///Document Status Id
        ///</summary>
        [ApiMember(Description="Document Status Id", ParameterType="query")]
        public virtual Guid DocumentStatusId { get; set; }

        ///<summary>
        ///The Document Status
        ///</summary>
        [ApiMember(Description="The Document Status", ParameterType="query")]
        public virtual string DocumentStatus { get; set; }
    }

    public partial class AutomationModel
    {
        ///<summary>
        ///The unique automation Id
        ///</summary>
        [ApiMember(Description="The unique automation Id", ParameterType="query")]
        public virtual Guid AutomationId { get; set; }

        ///<summary>
        ///The automation type Id
        ///</summary>
        [ApiMember(Description="The automation type Id", ParameterType="query")]
        public virtual Guid AutomationTypeId { get; set; }

        ///<summary>
        ///The automation type
        ///</summary>
        [ApiMember(Description="The automation type", ParameterType="query")]
        public virtual string AutomationType { get; set; }

        ///<summary>
        ///The object this automation applies to
        ///</summary>
        [ApiMember(Description="The object this automation applies to", ParameterType="query")]
        public virtual Guid ObjectId { get; set; }

        ///<summary>
        ///The object name this automation applies to
        ///</summary>
        [ApiMember(Description="The object name this automation applies to", ParameterType="query")]
        public virtual string ObjectName { get; set; }

        ///<summary>
        ///The Id of the object type that this automation applies to. 
        ///</summary>
        [ApiMember(Description="The Id of the object type that this automation applies to. ", ParameterType="query")]
        public virtual Guid RmsTableCtxIdObject { get; set; }

        ///<summary>
        ///The name of the object type that this automation applies to.
        ///</summary>
        [ApiMember(Description="The name of the object type that this automation applies to.", ParameterType="query")]
        public virtual string RmsTableCtxName { get; set; }

        ///<summary>
        ///A guid list containing the selected system action Id's that trigger this automation.
        ///</summary>
        [ApiMember(Description="A guid list containing the selected system action Id's that trigger this automation.", ParameterType="query")]
        public virtual List<Guid> ActionList { get; set; }

        ///<summary>
        ///A comma separated string of the selected system action names that trigger this automation.
        ///</summary>
        [ApiMember(Description="A comma separated string of the selected system action names that trigger this automation.", ParameterType="query")]
        public virtual string Actions { get; set; }

        ///<summary>
        ///Name of the automation.
        ///</summary>
        [ApiMember(Description="Name of the automation.", ParameterType="query")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Description of the automation
        ///</summary>
        [ApiMember(Description="Description of the automation", ParameterType="query")]
        public virtual string Description { get; set; }

        ///<summary>
        ///Owner Contact Id
        ///</summary>
        [ApiMember(Description="Owner Contact Id", ParameterType="query")]
        public virtual Guid OwnerContactId { get; set; }

        ///<summary>
        ///Record Status of the automation.
        ///</summary>
        [ApiMember(Description="Record Status of the automation.", ParameterType="query")]
        public virtual string RecordStatus { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get details of a specific documentation automation
    ///</summary>
    [Api(Description="Get details of a specific documentation automation")]
    public partial class GetDocumentationAutomation
    {
        ///<summary>
        ///Automation Id.
        ///</summary>
        [ApiMember(Description="Automation Id.", ParameterType="path")]
        public virtual Guid AutomationId { get; set; }
    }

    [ApiResponse(Description="Returns a documentation automation")]
    public partial class GetDocumentationAutomationResponse
    {
        ///<summary>
        ///Documentation Automation
        ///</summary>
        [ApiMember(Description="Documentation Automation")]
        public virtual AutoDocumentationModel Automation { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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