Platform Subscription API

<back to all web services

SaveIntegration

Requires Authentication
The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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-01T00:00:00.0000000","EndTime":"0001-01-01T00:00:00.0000000","SettingsFile":{"index":0,"Name":"String","Content":"String","ContentType":"String","FileSizeKB":0,"BlobUri":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Notes":"String"},"ResultsFile":{"index":0,"Name":"String","Content":"String","ContentType":"String","FileSizeKB":0,"BlobUri":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Notes":"String"},"IssuesFile":{"index":0,"Name":"String","Content":"String","ContentType":"String","FileSizeKB":0,"BlobUri":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Notes":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}