| All Verbs | /api/integration |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class SaveIntegration
{
/**
* The integration reference ID which is the gateway packet id. If the value passed is empty, new packet record will be created.
*/
@ApiMember(DataType="Guid?", Description="The integration reference ID which is the gateway packet id. If the value passed is empty, new packet record will be created.", Name="IntegrationId")
public UUID IntegrationId = null;
/**
* Name or title of the integration
*/
@ApiMember(DataType="string", Description="Name or title of the integration", Name="Title")
public String Title = null;
/**
* Version information of the integration module.
*/
@ApiMember(DataType="IntegrationVersion", Description="Version information of the integration module.", Name="Version")
public IntegrationVersion Version = null;
/**
* User who requested the integration
*/
@ApiMember(DataType="string", Description="User who requested the integration", Name="User")
public String User = null;
/**
* Local computer where the integration is performed on
*/
@ApiMember(DataType="string", Description="Local computer where the integration is performed on", Name="LocalComputer")
public String LocalComputer = null;
/**
* Windows version information
*/
@ApiMember(DataType="IntegrationWinVersion", Description="Windows version information", Name="WinVersion")
public IntegrationWinVersion WinVersion = null;
/**
* Completed status of the integration
*/
@ApiMember(DataType="bool", Description="Completed status of the integration", Name="Completed")
public Boolean Completed = null;
/**
* Status of the integration.
*/
@ApiMember(DataType="string", Description="Status of the integration.", Name="Status")
public String Status = null;
/**
* Start date and time of the integration.
*/
@ApiMember(DataType="DateTime", Description="Start date and time of the integration.", Name="StartTime")
public Date StartTime = null;
/**
* End date and time of the integration.
*/
@ApiMember(DataType="DateTime", Description="End date and time of the integration.", Name="EndTime")
public Date EndTime = null;
/**
* Settings XML being used in the integration.
*/
@ApiMember(DataType="IntegrationFileModel", Description="Settings XML being used in the integration.", Name="SettingsFile")
public IntegrationFileModel SettingsFile = null;
/**
* File (xml) containing the results of the integration
*/
@ApiMember(DataType="IntegrationFileModel", Description="File (xml) containing the results of the integration", Name="ResultsFile")
public IntegrationFileModel ResultsFile = null;
/**
* File (xml) containing the issues that were identified during integration
*/
@ApiMember(DataType="IntegrationFileModel", Description="File (xml) containing the issues that were identified during integration", Name="IssuesFile")
public IntegrationFileModel IssuesFile = null;
public UUID getIntegrationId() { return IntegrationId; }
public SaveIntegration setIntegrationId(UUID value) { this.IntegrationId = value; return this; }
public String getTitle() { return Title; }
public SaveIntegration setTitle(String value) { this.Title = value; return this; }
public IntegrationVersion getVersion() { return Version; }
public SaveIntegration setVersion(IntegrationVersion value) { this.Version = value; return this; }
public String getUser() { return User; }
public SaveIntegration setUser(String value) { this.User = value; return this; }
public String getLocalComputer() { return LocalComputer; }
public SaveIntegration setLocalComputer(String value) { this.LocalComputer = value; return this; }
public IntegrationWinVersion getWinVersion() { return WinVersion; }
public SaveIntegration setWinVersion(IntegrationWinVersion value) { this.WinVersion = value; return this; }
public Boolean isCompleted() { return Completed; }
public SaveIntegration setCompleted(Boolean value) { this.Completed = value; return this; }
public String getStatus() { return Status; }
public SaveIntegration setStatus(String value) { this.Status = value; return this; }
public Date getStartTime() { return StartTime; }
public SaveIntegration setStartTime(Date value) { this.StartTime = value; return this; }
public Date getEndTime() { return EndTime; }
public SaveIntegration setEndTime(Date value) { this.EndTime = value; return this; }
public IntegrationFileModel getSettingsFile() { return SettingsFile; }
public SaveIntegration setSettingsFile(IntegrationFileModel value) { this.SettingsFile = value; return this; }
public IntegrationFileModel getResultsFile() { return ResultsFile; }
public SaveIntegration setResultsFile(IntegrationFileModel value) { this.ResultsFile = value; return this; }
public IntegrationFileModel getIssuesFile() { return IssuesFile; }
public SaveIntegration setIssuesFile(IntegrationFileModel value) { this.IssuesFile = value; return this; }
}
public static class IntegrationVersion
{
public Integer Major = null;
public Integer Minor = null;
public Integer Build = null;
public Integer Revision = null;
public Integer getMajor() { return Major; }
public IntegrationVersion setMajor(Integer value) { this.Major = value; return this; }
public Integer getMinor() { return Minor; }
public IntegrationVersion setMinor(Integer value) { this.Minor = value; return this; }
public Integer getBuild() { return Build; }
public IntegrationVersion setBuild(Integer value) { this.Build = value; return this; }
public Integer getRevision() { return Revision; }
public IntegrationVersion setRevision(Integer value) { this.Revision = value; return this; }
}
public static class IntegrationWinVersion
{
public String Name = null;
public String Version = null;
public Integer Build = null;
public String ServicePack = null;
public String getName() { return Name; }
public IntegrationWinVersion setName(String value) { this.Name = value; return this; }
public String getVersion() { return Version; }
public IntegrationWinVersion setVersion(String value) { this.Version = value; return this; }
public Integer getBuild() { return Build; }
public IntegrationWinVersion setBuild(Integer value) { this.Build = value; return this; }
public String getServicePack() { return ServicePack; }
public IntegrationWinVersion setServicePack(String value) { this.ServicePack = value; return this; }
}
public static class IntegrationFileModel
{
public Integer index = null;
public String Name = null;
public String Content = null;
public String ContentType = null;
public Integer FileSizeKB = null;
public String BlobUri = null;
public Date CreatedDate = null;
public String Notes = null;
public Integer getIndex() { return index; }
public IntegrationFileModel setIndex(Integer value) { this.index = value; return this; }
public String getName() { return Name; }
public IntegrationFileModel setName(String value) { this.Name = value; return this; }
public String getContent() { return Content; }
public IntegrationFileModel setContent(String value) { this.Content = value; return this; }
public String getContentType() { return ContentType; }
public IntegrationFileModel setContentType(String value) { this.ContentType = value; return this; }
public Integer getFileSizeKB() { return FileSizeKB; }
public IntegrationFileModel setFileSizeKB(Integer value) { this.FileSizeKB = value; return this; }
public String getBlobUri() { return BlobUri; }
public IntegrationFileModel setBlobUri(String value) { this.BlobUri = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public IntegrationFileModel setCreatedDate(Date value) { this.CreatedDate = value; return this; }
public String getNotes() { return Notes; }
public IntegrationFileModel setNotes(String value) { this.Notes = value; return this; }
}
@ApiResponse(Description="Track integration result")
public static class SaveIntegrationResponse
{
public UUID IntegrationId = null;
public ResponseStatus ResponseStatus = null;
public UUID getIntegrationId() { return IntegrationId; }
public SaveIntegrationResponse setIntegrationId(UUID value) { this.IntegrationId = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public SaveIntegrationResponse 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/integration HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Title: String,
Version:
{
Major: 0,
Minor: 0,
Build: 0,
Revision: 0
},
User: String,
LocalComputer: String,
WinVersion:
{
Name: String,
Version: String,
Build: 0,
ServicePack: String
},
Completed: False,
Status: String,
StartTime: 0001-01-01,
EndTime: 0001-01-01,
SettingsFile:
{
index: 0,
Name: String,
Content: String,
ContentType: String,
FileSizeKB: 0,
BlobUri: String,
CreatedDate: 0001-01-01,
Notes: String
},
ResultsFile:
{
index: 0,
Name: String,
Content: String,
ContentType: String,
FileSizeKB: 0,
BlobUri: String,
CreatedDate: 0001-01-01,
Notes: String
},
IssuesFile:
{
index: 0,
Name: String,
Content: String,
ContentType: String,
FileSizeKB: 0,
BlobUri: String,
CreatedDate: 0001-01-01,
Notes: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}