| GET | /api/automation/{AutomationId}/inspection |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get details of a specific inspection automation
*/
@Api(Description="Get details of a specific inspection automation")
open class GetInspectionAutomation
{
/**
* Automation Id.
*/
@ApiMember(Description="Automation Id.", ParameterType="path")
open var AutomationId:UUID? = null
}
@ApiResponse(Description="Returns an inspection automation")
open class GetInspectionAutomationResponse
{
/**
* Inspection Automation
*/
@ApiMember(Description="Inspection Automation")
open var Automation:AutoInspectionModel? = null
open var ResponseStatus:ResponseStatus? = null
}
open class AutoInspectionModel : AutomationModel()
{
/**
* The inspection type for the template.
*/
@ApiMember(Description="The inspection type for the template.", ParameterType="query")
open var InspectionTypeId:UUID? = null
/**
* The template to base the new inspection on.
*/
@ApiMember(Description="The template to base the new inspection on.", ParameterType="query")
open var InspectionTemplateId:UUID? = null
/**
* 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.
*/
@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")
open var ContactRoleId:UUID? = null
/**
* If this is true, then if a project inspection for this template already exists, we will not create another inspection.
*/
@ApiMember(Description="If this is true, then if a project inspection for this template already exists, we will not create another inspection.", ParameterType="query")
open var IgnoreIfExists:Boolean? = null
}
open class AutomationModel
{
/**
* The unique automation Id
*/
@ApiMember(Description="The unique automation Id", ParameterType="query")
open var AutomationId:UUID? = null
/**
* The automation type Id
*/
@ApiMember(Description="The automation type Id", ParameterType="query")
open var AutomationTypeId:UUID? = null
/**
* The automation type
*/
@ApiMember(Description="The automation type", ParameterType="query")
open var AutomationType:String? = null
/**
* The object this automation applies to
*/
@ApiMember(Description="The object this automation applies to", ParameterType="query")
open var ObjectId:UUID? = null
/**
* The object name this automation applies to
*/
@ApiMember(Description="The object name this automation applies to", ParameterType="query")
open var ObjectName:String? = null
/**
* 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")
open var RmsTableCtxIdObject:UUID? = null
/**
* 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")
open var RmsTableCtxName:String? = null
/**
* 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")
open var ActionList:ArrayList<UUID>? = null
/**
* 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")
open var Actions:String? = null
/**
* Name of the automation.
*/
@ApiMember(Description="Name of the automation.", ParameterType="query")
open var Name:String? = null
/**
* Description of the automation
*/
@ApiMember(Description="Description of the automation", ParameterType="query")
open var Description:String? = null
/**
* Owner Contact Id
*/
@ApiMember(Description="Owner Contact Id", ParameterType="query")
open var OwnerContactId:UUID? = null
/**
* Record Status of the automation.
*/
@ApiMember(Description="Record Status of the automation.", ParameterType="query")
open var RecordStatus:String? = null
}
Kotlin GetInspectionAutomation 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}/inspection HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Automation":{"InspectionTypeId":"00000000-0000-0000-0000-000000000000","InspectionTemplateId":"00000000-0000-0000-0000-000000000000","ContactRoleId":"00000000-0000-0000-0000-000000000000","IgnoreIfExists":false,"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"}}}