| GET | /api/automation/{AutomationId}/inspection |
|---|
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 AutoInspectionModel() =
inherit AutomationModel()
///<summary>
///The inspection type for the template.
///</summary>
[<ApiMember(Description="The inspection type for the template.", ParameterType="query")>]
member val InspectionTypeId:Guid = new Guid() with get,set
///<summary>
///The template to base the new inspection on.
///</summary>
[<ApiMember(Description="The template to base the new inspection on.", ParameterType="query")>]
member val InspectionTemplateId:Guid = new Guid() with get,set
///<summary>
///The inspector chosen for this inspection will be a contact linked to the project in this role. If no one matches the description, the inspector is not set.
///</summary>
[<ApiMember(Description="The inspector chosen for this inspection will be a contact linked to the project in this role. If no one matches the description, the inspector is not set. ", ParameterType="query")>]
member val ContactRoleId:Guid = new Guid() with get,set
///<summary>
///If this is true, then if a project inspection for this template already exists, we will not create another inspection.
///</summary>
[<ApiMember(Description="If this is true, then if a project inspection for this template already exists, we will not create another inspection.", ParameterType="query")>]
member val IgnoreIfExists:Boolean = new Boolean() with get,set
[<ApiResponse(Description="Returns an inspection automation")>]
[<AllowNullLiteral>]
type GetInspectionAutomationResponse() =
///<summary>
///Inspection Automation
///</summary>
[<ApiMember(Description="Inspection Automation")>]
member val Automation:AutoInspectionModel = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get details of a specific inspection automation
///</summary>
[<Api(Description="Get details of a specific inspection automation")>]
[<AllowNullLiteral>]
type GetInspectionAutomation() =
///<summary>
///Automation Id.
///</summary>
[<ApiMember(Description="Automation Id.", ParameterType="path")>]
member val AutomationId:Guid = new Guid() with get,set
F# GetInspectionAutomation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/automation/{AutomationId}/inspection HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Automation:
{
IgnoreIfExists: False,
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
}
}
}