| GET | /api/automation/{AutomationId}/documentation |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get details of a specific documentation automation
*/
@Api(Description="Get details of a specific documentation automation")
open class GetDocumentationAutomation
{
/**
* Automation Id.
*/
@ApiMember(Description="Automation Id.", ParameterType="path")
open var AutomationId:UUID? = null
}
@ApiResponse(Description="Returns a documentation automation")
open class GetDocumentationAutomationResponse
{
/**
* Documentation Automation
*/
@ApiMember(Description="Documentation Automation")
open var Automation:AutoDocumentationModel? = null
open var ResponseStatus:ResponseStatus? = null
}
open class AutoDocumentationModel : AutomationModel()
{
/**
* Report Id
*/
@ApiMember(Description="Report Id", ParameterType="query")
open var ReportId:UUID? = null
/**
* Report Name
*/
@ApiMember(Description="Report Name", ParameterType="query")
open var Report:String? = null
/**
* Document Type Id
*/
@ApiMember(Description="Document Type Id", ParameterType="query")
open var DocumentTypeId:UUID? = null
/**
* Document Type
*/
@ApiMember(Description="Document Type", ParameterType="query")
open var DocumentType:String? = null
/**
* Document Status Id
*/
@ApiMember(Description="Document Status Id", ParameterType="query")
open var DocumentStatusId:UUID? = null
/**
* The Document Status
*/
@ApiMember(Description="The Document Status", ParameterType="query")
open var DocumentStatus:String? = 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 GetDocumentationAutomation 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}/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
}
}
}