| PUT | /api/automation/inspection/{AutomationId} | ||
|---|---|---|---|
| POST | /api/automation/inspection |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Add or update an inspection automation for an object
*/
@Api(Description="Add or update an inspection automation for an object")
public static class SaveAutoInspection
{
/**
* Details of the automation to be added or updated.
*/
@ApiMember(Description="Details of the automation to be added or updated.", ParameterType="query")
public AutoInspectionModel Automation = null;
/**
* Id of the automation.
*/
@ApiMember(Description="Id of the automation.", ParameterType="path")
public UUID AutomationId = null;
public AutoInspectionModel getAutomation() { return Automation; }
public SaveAutoInspection setAutomation(AutoInspectionModel value) { this.Automation = value; return this; }
public UUID getAutomationId() { return AutomationId; }
public SaveAutoInspection setAutomationId(UUID value) { this.AutomationId = value; return this; }
}
public static class AutoInspectionModel extends AutomationModel
{
/**
* The inspection type for the template.
*/
@ApiMember(Description="The inspection type for the template.", ParameterType="query")
public UUID InspectionTypeId = null;
/**
* The template to base the new inspection on.
*/
@ApiMember(Description="The template to base the new inspection on.", ParameterType="query")
public UUID InspectionTemplateId = 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")
public UUID ContactRoleId = 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")
public Boolean IgnoreIfExists = null;
public UUID getInspectionTypeId() { return InspectionTypeId; }
public AutoInspectionModel setInspectionTypeId(UUID value) { this.InspectionTypeId = value; return this; }
public UUID getInspectionTemplateId() { return InspectionTemplateId; }
public AutoInspectionModel setInspectionTemplateId(UUID value) { this.InspectionTemplateId = value; return this; }
public UUID getContactRoleId() { return ContactRoleId; }
public AutoInspectionModel setContactRoleId(UUID value) { this.ContactRoleId = value; return this; }
public Boolean isIgnoreIfExists() { return IgnoreIfExists; }
public AutoInspectionModel setIgnoreIfExists(Boolean value) { this.IgnoreIfExists = 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; }
}
@ApiResponse(Description="List of automations that are setup for an object")
public static class GetAutomationsForObjectResponse
{
/**
* List of automations.
*/
@ApiMember(Description="List of automations.")
public ArrayList<AutomationModel> Automations = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<AutomationModel> getAutomations() { return Automations; }
public GetAutomationsForObjectResponse setAutomations(ArrayList<AutomationModel> value) { this.Automations = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetAutomationsForObjectResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
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.
POST /api/automation/inspection HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
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
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Automations:
[
{
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
}
}
}