Platform Subscription API

<back to all web services

SaveIntegration

Requires Authentication
The following routes are available for this service:
All Verbs/api/integration
"use strict";
export class SaveIntegrationResponse {
    /** @param {{IntegrationId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    IntegrationId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class IntegrationVersion {
    /** @param {{Major?:number,Minor?:number,Build?:number,Revision?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Major;
    /** @type {number} */
    Minor;
    /** @type {number} */
    Build;
    /** @type {number} */
    Revision;
}
export class IntegrationWinVersion {
    /** @param {{Name?:string,Version?:string,Build?:number,ServicePack?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Version;
    /** @type {number} */
    Build;
    /** @type {string} */
    ServicePack;
}
export class IntegrationFileModel {
    /** @param {{index?:number,Name?:string,Content?:string,ContentType?:string,FileSizeKB?:number,BlobUri?:string,CreatedDate?:string,Notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    index;
    /** @type {string} */
    Name;
    /** @type {string} */
    Content;
    /** @type {string} */
    ContentType;
    /** @type {number} */
    FileSizeKB;
    /** @type {string} */
    BlobUri;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    Notes;
}
export class SaveIntegration {
    /** @param {{IntegrationId?:string,Title?:string,Version?:IntegrationVersion,User?:string,LocalComputer?:string,WinVersion?:IntegrationWinVersion,Completed?:boolean,Status?:string,StartTime?:string,EndTime?:string,SettingsFile?:IntegrationFileModel,ResultsFile?:IntegrationFileModel,IssuesFile?:IntegrationFileModel}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The integration reference ID which is the gateway packet id.  If the value passed is empty, new packet record will be created. */
    IntegrationId;
    /**
     * @type {string}
     * @description Name or title of the integration */
    Title;
    /**
     * @type {IntegrationVersion}
     * @description Version information of the integration module. */
    Version;
    /**
     * @type {string}
     * @description User who requested the integration */
    User;
    /**
     * @type {string}
     * @description Local computer where the integration is performed on */
    LocalComputer;
    /**
     * @type {IntegrationWinVersion}
     * @description Windows version information */
    WinVersion;
    /**
     * @type {boolean}
     * @description Completed status of the integration */
    Completed;
    /**
     * @type {string}
     * @description Status of the integration. */
    Status;
    /**
     * @type {string}
     * @description Start date and time of the integration. */
    StartTime;
    /**
     * @type {string}
     * @description End date and time of the integration. */
    EndTime;
    /**
     * @type {IntegrationFileModel}
     * @description Settings XML being used in the integration. */
    SettingsFile;
    /**
     * @type {IntegrationFileModel}
     * @description File (xml) containing the results of the integration */
    ResultsFile;
    /**
     * @type {IntegrationFileModel}
     * @description File (xml) containing the issues that were identified during integration */
    IssuesFile;
}

JavaScript SaveIntegration DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

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