| GET | /api/automation/{AutomationId}/documentation |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get details of a specific documentation automation
*/
@Api(Description="Get details of a specific documentation automation")
public static class GetDocumentationAutomation
{
/**
* Automation Id.
*/
@ApiMember(Description="Automation Id.", ParameterType="path")
public UUID AutomationId = null;
public UUID getAutomationId() { return AutomationId; }
public GetDocumentationAutomation setAutomationId(UUID value) { this.AutomationId = value; return this; }
}
@ApiResponse(Description="Returns a documentation automation")
public static class GetDocumentationAutomationResponse
{
/**
* Documentation Automation
*/
@ApiMember(Description="Documentation Automation")
public AutoDocumentationModel Automation = null;
public ResponseStatus ResponseStatus = null;
public AutoDocumentationModel getAutomation() { return Automation; }
public GetDocumentationAutomationResponse setAutomation(AutoDocumentationModel value) { this.Automation = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetDocumentationAutomationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AutoDocumentationModel extends AutomationModel
{
/**
* Report Id
*/
@ApiMember(Description="Report Id", ParameterType="query")
public UUID ReportId = null;
/**
* Report Name
*/
@ApiMember(Description="Report Name", ParameterType="query")
public String Report = null;
/**
* Document Type Id
*/
@ApiMember(Description="Document Type Id", ParameterType="query")
public UUID DocumentTypeId = null;
/**
* Document Type
*/
@ApiMember(Description="Document Type", ParameterType="query")
public String DocumentType = null;
/**
* Document Status Id
*/
@ApiMember(Description="Document Status Id", ParameterType="query")
public UUID DocumentStatusId = null;
/**
* The Document Status
*/
@ApiMember(Description="The Document Status", ParameterType="query")
public String DocumentStatus = null;
public UUID getReportId() { return ReportId; }
public AutoDocumentationModel setReportId(UUID value) { this.ReportId = value; return this; }
public String getReport() { return Report; }
public AutoDocumentationModel setReport(String value) { this.Report = value; return this; }
public UUID getDocumentTypeId() { return DocumentTypeId; }
public AutoDocumentationModel setDocumentTypeId(UUID value) { this.DocumentTypeId = value; return this; }
public String getDocumentType() { return DocumentType; }
public AutoDocumentationModel setDocumentType(String value) { this.DocumentType = value; return this; }
public UUID getDocumentStatusId() { return DocumentStatusId; }
public AutoDocumentationModel setDocumentStatusId(UUID value) { this.DocumentStatusId = value; return this; }
public String getDocumentStatus() { return DocumentStatus; }
public AutoDocumentationModel setDocumentStatus(String value) { this.DocumentStatus = value; return this; }
}
public static class AutomationModel
{
/**
* The unique automation Id
*/
@ApiMember(Description="The unique automation Id", ParameterType="query")
public UUID AutomationId = null;
/**
* The automation type Id
*/
@ApiMember(Description="The automation type Id", ParameterType="query")
public UUID AutomationTypeId = null;
/**
* The automation type
*/
@ApiMember(Description="The automation type", ParameterType="query")
public String AutomationType = null;
/**
* The object this automation applies to
*/
@ApiMember(Description="The object this automation applies to", ParameterType="query")
public UUID ObjectId = null;
/**
* The object name this automation applies to
*/
@ApiMember(Description="The object name this automation applies to", ParameterType="query")
public String ObjectName = 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")
public UUID RmsTableCtxIdObject = 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")
public String RmsTableCtxName = 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")
public ArrayList<UUID> ActionList = 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")
public String Actions = null;
/**
* Name of the automation.
*/
@ApiMember(Description="Name of the automation.", ParameterType="query")
public String Name = null;
/**
* Description of the automation
*/
@ApiMember(Description="Description of the automation", ParameterType="query")
public String Description = null;
/**
* Owner Contact Id
*/
@ApiMember(Description="Owner Contact Id", ParameterType="query")
public UUID OwnerContactId = null;
/**
* Record Status of the automation.
*/
@ApiMember(Description="Record Status of the automation.", ParameterType="query")
public String RecordStatus = null;
public UUID getAutomationId() { return AutomationId; }
public AutomationModel setAutomationId(UUID value) { this.AutomationId = value; return this; }
public UUID getAutomationTypeId() { return AutomationTypeId; }
public AutomationModel setAutomationTypeId(UUID value) { this.AutomationTypeId = value; return this; }
public String getAutomationType() { return AutomationType; }
public AutomationModel setAutomationType(String value) { this.AutomationType = value; return this; }
public UUID getObjectId() { return ObjectId; }
public AutomationModel setObjectId(UUID value) { this.ObjectId = value; return this; }
public String getObjectName() { return ObjectName; }
public AutomationModel setObjectName(String value) { this.ObjectName = value; return this; }
public UUID getRmsTableCtxIdObject() { return RmsTableCtxIdObject; }
public AutomationModel setRmsTableCtxIdObject(UUID value) { this.RmsTableCtxIdObject = value; return this; }
public String getRmsTableCtxName() { return RmsTableCtxName; }
public AutomationModel setRmsTableCtxName(String value) { this.RmsTableCtxName = value; return this; }
public ArrayList<UUID> getActionList() { return ActionList; }
public AutomationModel setActionList(ArrayList<UUID> value) { this.ActionList = value; return this; }
public String getActions() { return Actions; }
public AutomationModel setActions(String value) { this.Actions = value; return this; }
public String getName() { return Name; }
public AutomationModel setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public AutomationModel setDescription(String value) { this.Description = value; return this; }
public UUID getOwnerContactId() { return OwnerContactId; }
public AutomationModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public AutomationModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
}
}
Java GetDocumentationAutomation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}