Richemont.Booster2.PublicApi

<back to all web services

GetTaskDetail

Requires Authentication
The following routes are available for this service:
GET/tasks/{asyncTaskId}Get task detail of authorized user
"use strict";
export class Task {
    /** @param {{asyncTaskId?:string,type?:string,requestDate?:string,status?:string,percentage?:number,brand?:string,downloadUrl?:string,signedDownloadUrl?:string,totalResults?:number,totalSucceeded?:number,totalFailed?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Async task ID */
    asyncTaskId;
    /**
     * @type {string}
     * @description Type of requested async task, e.g 'stock', 'sellout', 'crm' */
    type;
    /**
     * @type {string}
     * @description Async task creation date */
    requestDate;
    /**
     * @type {string}
     * @description Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR' */
    status;
    /**
     * @type {number}
     * @description Percentage of completion */
    percentage;
    /**
     * @type {string}
     * @description Brand Trigram */
    brand;
    /**
     * @type {string}
     * @description Download url of created files */
    downloadUrl;
    /**
     * @type {string}
     * @description Presigned expiring download url */
    signedDownloadUrl;
    /**
     * @type {?number}
     * @description Total count of operations */
    totalResults;
    /**
     * @type {?number}
     * @description Count of successful operations */
    totalSucceeded;
    /**
     * @type {?number}
     * @description Count of failed operations */
    totalFailed;
}
export class GetTaskDetailResponse extends Task {
    /** @param {{asyncTaskId?:string,type?:string,requestDate?:string,status?:string,percentage?:number,brand?:string,downloadUrl?:string,signedDownloadUrl?:string,totalResults?:number,totalSucceeded?:number,totalFailed?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetTaskDetail {
    /** @param {{asyncTaskId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Async task ID */
    asyncTaskId;
}

JavaScript GetTaskDetail 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.

GET /tasks/{asyncTaskId} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json

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

{"asyncTaskId":"00000000000000000000000000000000","type":"String","requestDate":"String","status":"String","percentage":0,"brand":"String","downloadUrl":"String","signedDownloadUrl":"String","totalResults":0,"totalSucceeded":0,"totalFailed":0}