| All Verbs | /api/integration |
|---|
// @ApiResponse(Description="Track integration result")
export class SaveIntegrationResponse
{
public IntegrationId: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<SaveIntegrationResponse>) { (Object as any).assign(this, init); }
}
export class IntegrationVersion
{
public Major: number;
public Minor: number;
public Build: number;
public Revision: number;
public constructor(init?: Partial<IntegrationVersion>) { (Object as any).assign(this, init); }
}
export class IntegrationWinVersion
{
public Name: string;
public Version: string;
public Build: number;
public ServicePack: string;
public constructor(init?: Partial<IntegrationWinVersion>) { (Object as any).assign(this, init); }
}
export class IntegrationFileModel
{
public index: number;
public Name: string;
public Content: string;
public ContentType: string;
public FileSizeKB: number;
public BlobUri: string;
public CreatedDate: string;
public Notes: string;
public constructor(init?: Partial<IntegrationFileModel>) { (Object as any).assign(this, init); }
}
export class SaveIntegration
{
/** @description 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 IntegrationId: string;
/** @description Name or title of the integration */
// @ApiMember(DataType="string", Description="Name or title of the integration", Name="Title")
public Title: string;
/** @description Version information of the integration module. */
// @ApiMember(DataType="IntegrationVersion", Description="Version information of the integration module.", Name="Version")
public Version: IntegrationVersion;
/** @description User who requested the integration */
// @ApiMember(DataType="string", Description="User who requested the integration", Name="User")
public User: string;
/** @description Local computer where the integration is performed on */
// @ApiMember(DataType="string", Description="Local computer where the integration is performed on", Name="LocalComputer")
public LocalComputer: string;
/** @description Windows version information */
// @ApiMember(DataType="IntegrationWinVersion", Description="Windows version information", Name="WinVersion")
public WinVersion: IntegrationWinVersion;
/** @description Completed status of the integration */
// @ApiMember(DataType="bool", Description="Completed status of the integration", Name="Completed")
public Completed: boolean;
/** @description Status of the integration. */
// @ApiMember(DataType="string", Description="Status of the integration.", Name="Status")
public Status: string;
/** @description Start date and time of the integration. */
// @ApiMember(DataType="DateTime", Description="Start date and time of the integration.", Name="StartTime")
public StartTime: string;
/** @description End date and time of the integration. */
// @ApiMember(DataType="DateTime", Description="End date and time of the integration.", Name="EndTime")
public EndTime: string;
/** @description Settings XML being used in the integration. */
// @ApiMember(DataType="IntegrationFileModel", Description="Settings XML being used in the integration.", Name="SettingsFile")
public SettingsFile: IntegrationFileModel;
/** @description File (xml) containing the results of the integration */
// @ApiMember(DataType="IntegrationFileModel", Description="File (xml) containing the results of the integration", Name="ResultsFile")
public ResultsFile: IntegrationFileModel;
/** @description 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 IssuesFile: IntegrationFileModel;
public constructor(init?: Partial<SaveIntegration>) { (Object as any).assign(this, init); }
}
TypeScript SaveIntegration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<SaveIntegration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Completed>false</Completed>
<EndTime>0001-01-01T00:00:00</EndTime>
<IntegrationId>00000000-0000-0000-0000-000000000000</IntegrationId>
<IssuesFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:BlobUri>String</d2p1:BlobUri>
<d2p1:Content>String</d2p1:Content>
<d2p1:ContentType>String</d2p1:ContentType>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:FileSizeKB>0</d2p1:FileSizeKB>
<d2p1:Name>String</d2p1:Name>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:index>0</d2p1:index>
</IssuesFile>
<LocalComputer>String</LocalComputer>
<ResultsFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:BlobUri>String</d2p1:BlobUri>
<d2p1:Content>String</d2p1:Content>
<d2p1:ContentType>String</d2p1:ContentType>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:FileSizeKB>0</d2p1:FileSizeKB>
<d2p1:Name>String</d2p1:Name>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:index>0</d2p1:index>
</ResultsFile>
<SettingsFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:BlobUri>String</d2p1:BlobUri>
<d2p1:Content>String</d2p1:Content>
<d2p1:ContentType>String</d2p1:ContentType>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:FileSizeKB>0</d2p1:FileSizeKB>
<d2p1:Name>String</d2p1:Name>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:index>0</d2p1:index>
</SettingsFile>
<StartTime>0001-01-01T00:00:00</StartTime>
<Status>String</Status>
<Title>String</Title>
<User>String</User>
<Version xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:Build>0</d2p1:Build>
<d2p1:Major>0</d2p1:Major>
<d2p1:Minor>0</d2p1:Minor>
<d2p1:Revision>0</d2p1:Revision>
</Version>
<WinVersion xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:Build>0</d2p1:Build>
<d2p1:Name>String</d2p1:Name>
<d2p1:ServicePack>String</d2p1:ServicePack>
<d2p1:Version>String</d2p1:Version>
</WinVersion>
</SaveIntegration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveIntegrationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<IntegrationId>00000000-0000-0000-0000-000000000000</IntegrationId>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</SaveIntegrationResponse>