| All Verbs | /api/integration |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open 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")
open var IntegrationId:UUID? = null
/**
* Name or title of the integration
*/
@ApiMember(DataType="string", Description="Name or title of the integration", Name="Title")
open var Title:String? = null
/**
* Version information of the integration module.
*/
@ApiMember(DataType="IntegrationVersion", Description="Version information of the integration module.", Name="Version")
open var Version:IntegrationVersion? = null
/**
* User who requested the integration
*/
@ApiMember(DataType="string", Description="User who requested the integration", Name="User")
open var User:String? = null
/**
* Local computer where the integration is performed on
*/
@ApiMember(DataType="string", Description="Local computer where the integration is performed on", Name="LocalComputer")
open var LocalComputer:String? = null
/**
* Windows version information
*/
@ApiMember(DataType="IntegrationWinVersion", Description="Windows version information", Name="WinVersion")
open var WinVersion:IntegrationWinVersion? = null
/**
* Completed status of the integration
*/
@ApiMember(DataType="bool", Description="Completed status of the integration", Name="Completed")
open var Completed:Boolean? = null
/**
* Status of the integration.
*/
@ApiMember(DataType="string", Description="Status of the integration.", Name="Status")
open var Status:String? = null
/**
* Start date and time of the integration.
*/
@ApiMember(DataType="DateTime", Description="Start date and time of the integration.", Name="StartTime")
open var StartTime:Date? = null
/**
* End date and time of the integration.
*/
@ApiMember(DataType="DateTime", Description="End date and time of the integration.", Name="EndTime")
open var EndTime:Date? = null
/**
* Settings XML being used in the integration.
*/
@ApiMember(DataType="IntegrationFileModel", Description="Settings XML being used in the integration.", Name="SettingsFile")
open var SettingsFile:IntegrationFileModel? = null
/**
* File (xml) containing the results of the integration
*/
@ApiMember(DataType="IntegrationFileModel", Description="File (xml) containing the results of the integration", Name="ResultsFile")
open var ResultsFile:IntegrationFileModel? = 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")
open var IssuesFile:IntegrationFileModel? = null
}
open class IntegrationVersion
{
open var Major:Int? = null
open var Minor:Int? = null
open var Build:Int? = null
open var Revision:Int? = null
}
open class IntegrationWinVersion
{
open var Name:String? = null
open var Version:String? = null
open var Build:Int? = null
open var ServicePack:String? = null
}
open class IntegrationFileModel
{
open var index:Int? = null
open var Name:String? = null
open var Content:String? = null
open var ContentType:String? = null
open var FileSizeKB:Int? = null
open var BlobUri:String? = null
open var CreatedDate:Date? = null
open var Notes:String? = null
}
@ApiResponse(Description="Track integration result")
open class SaveIntegrationResponse
{
open var IntegrationId:UUID? = null
open var ResponseStatus:ResponseStatus? = null
}
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
}
}
}