| GET | /api/automation/{AutomationId}/documentation |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type AutomationModel() =
///<summary>
///The unique automation Id
///</summary>
[<ApiMember(Description="The unique automation Id", ParameterType="query")>]
member val AutomationId:Guid = new Guid() with get,set
///<summary>
///The automation type Id
///</summary>
[<ApiMember(Description="The automation type Id", ParameterType="query")>]
member val AutomationTypeId:Guid = new Guid() with get,set
///<summary>
///The automation type
///</summary>
[<ApiMember(Description="The automation type", ParameterType="query")>]
member val AutomationType:String = null with get,set
///<summary>
///The object this automation applies to
///</summary>
[<ApiMember(Description="The object this automation applies to", ParameterType="query")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///The object name this automation applies to
///</summary>
[<ApiMember(Description="The object name this automation applies to", ParameterType="query")>]
member val ObjectName:String = null with 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")>]
member val RmsTableCtxIdObject:Guid = new Guid() with 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")>]
member val RmsTableCtxName:String = null with 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")>]
member val ActionList:ResizeArray<Guid> = null with 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")>]
member val Actions:String = null with get,set
///<summary>
///Name of the automation.
///</summary>
[<ApiMember(Description="Name of the automation.", ParameterType="query")>]
member val Name:String = null with get,set
///<summary>
///Description of the automation
///</summary>
[<ApiMember(Description="Description of the automation", ParameterType="query")>]
member val Description:String = null with get,set
///<summary>
///Owner Contact Id
///</summary>
[<ApiMember(Description="Owner Contact Id", ParameterType="query")>]
member val OwnerContactId:Guid = new Guid() with get,set
///<summary>
///Record Status of the automation.
///</summary>
[<ApiMember(Description="Record Status of the automation.", ParameterType="query")>]
member val RecordStatus:String = null with get,set
[<AllowNullLiteral>]
type AutoDocumentationModel() =
inherit AutomationModel()
///<summary>
///Report Id
///</summary>
[<ApiMember(Description="Report Id", ParameterType="query")>]
member val ReportId:Guid = new Guid() with get,set
///<summary>
///Report Name
///</summary>
[<ApiMember(Description="Report Name", ParameterType="query")>]
member val Report:String = null with get,set
///<summary>
///Document Type Id
///</summary>
[<ApiMember(Description="Document Type Id", ParameterType="query")>]
member val DocumentTypeId:Guid = new Guid() with get,set
///<summary>
///Document Type
///</summary>
[<ApiMember(Description="Document Type", ParameterType="query")>]
member val DocumentType:String = null with get,set
///<summary>
///Document Status Id
///</summary>
[<ApiMember(Description="Document Status Id", ParameterType="query")>]
member val DocumentStatusId:Guid = new Guid() with get,set
///<summary>
///The Document Status
///</summary>
[<ApiMember(Description="The Document Status", ParameterType="query")>]
member val DocumentStatus:String = null with get,set
[<ApiResponse(Description="Returns a documentation automation")>]
[<AllowNullLiteral>]
type GetDocumentationAutomationResponse() =
///<summary>
///Documentation Automation
///</summary>
[<ApiMember(Description="Documentation Automation")>]
member val Automation:AutoDocumentationModel = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get details of a specific documentation automation
///</summary>
[<Api(Description="Get details of a specific documentation automation")>]
[<AllowNullLiteral>]
type GetDocumentationAutomation() =
///<summary>
///Automation Id.
///</summary>
[<ApiMember(Description="Automation Id.", ParameterType="path")>]
member val AutomationId:Guid = new Guid() with get,set
F# GetDocumentationAutomation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/automation/{AutomationId}/documentation HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Automation":{"ReportId":"00000000-0000-0000-0000-000000000000","Report":"String","DocumentTypeId":"00000000-0000-0000-0000-000000000000","DocumentType":"String","DocumentStatusId":"00000000-0000-0000-0000-000000000000","DocumentStatus":"String","AutomationId":"00000000-0000-0000-0000-000000000000","AutomationTypeId":"00000000-0000-0000-0000-000000000000","AutomationType":"String","ObjectId":"00000000-0000-0000-0000-000000000000","ObjectName":"String","RmsTableCtxIdObject":"00000000-0000-0000-0000-000000000000","RmsTableCtxName":"String","ActionList":["00000000-0000-0000-0000-000000000000"],"Actions":"String","Name":"String","Description":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}