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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDocumentationAutomationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Automation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ActionList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </d2p1:ActionList>
    <d2p1:Actions>String</d2p1:Actions>
    <d2p1:AutomationId>00000000-0000-0000-0000-000000000000</d2p1:AutomationId>
    <d2p1:AutomationType>String</d2p1:AutomationType>
    <d2p1:AutomationTypeId>00000000-0000-0000-0000-000000000000</d2p1:AutomationTypeId>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
    <d2p1:ObjectName>String</d2p1:ObjectName>
    <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:RmsTableCtxIdObject>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxIdObject>
    <d2p1:RmsTableCtxName>String</d2p1:RmsTableCtxName>
    <d2p1:DocumentStatus>String</d2p1:DocumentStatus>
    <d2p1:DocumentStatusId>00000000-0000-0000-0000-000000000000</d2p1:DocumentStatusId>
    <d2p1:DocumentType>String</d2p1:DocumentType>
    <d2p1:DocumentTypeId>00000000-0000-0000-0000-000000000000</d2p1:DocumentTypeId>
    <d2p1:Report>String</d2p1:Report>
    <d2p1:ReportId>00000000-0000-0000-0000-000000000000</d2p1:ReportId>
  </Automation>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetDocumentationAutomationResponse>