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

export class Task
{
    /** @description Async task ID */
    // @ApiMember(Description="Async task ID", IsRequired=true)
    public asyncTaskId: string;

    /** @description Type of requested async task, e.g 'stock', 'sellout', 'crm' */
    // @ApiMember(Description="Type of requested async task, e.g 'stock', 'sellout', 'crm'", IsRequired=true)
    public type: string;

    /** @description Async task creation date */
    // @ApiMember(Description="Async task creation date", IsRequired=true)
    public requestDate: string;

    /** @description Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR' */
    // @ApiMember(Description="Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR'", IsRequired=true)
    public status: string;

    /** @description Percentage of completion */
    // @ApiMember(Description="Percentage of completion", IsRequired=true)
    public percentage: number;

    /** @description Brand Trigram */
    // @ApiMember(Description="Brand Trigram", IsRequired=true)
    public brand: string;

    /** @description Download url of created files */
    // @ApiMember(Description="Download url of created files")
    public downloadUrl: string;

    /** @description Presigned expiring download url */
    // @ApiMember(Description="Presigned expiring download url")
    public signedDownloadUrl: string;

    /** @description Total count of operations */
    // @ApiMember(Description="Total count of operations")
    public totalResults?: number;

    /** @description Count of successful operations */
    // @ApiMember(Description="Count of successful operations")
    public totalSucceeded?: number;

    /** @description Count of failed operations */
    // @ApiMember(Description="Count of failed operations")
    public totalFailed?: number;

    public constructor(init?: Partial<Task>) { (Object as any).assign(this, init); }
}

export class GetTaskDetailResponse extends Task
{

    public constructor(init?: Partial<GetTaskDetailResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetTaskDetail
{
    /** @description Async task ID */
    // @ApiMember(Description="Async task ID", IsRequired=true)
    public asyncTaskId: string;

    public constructor(init?: Partial<GetTaskDetail>) { (Object as any).assign(this, init); }
}

TypeScript GetTaskDetail DTOs

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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTaskDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.NightlyProcess.ServiceModel">
  <asyncTaskId>00000000-0000-0000-0000-000000000000</asyncTaskId>
  <brand>String</brand>
  <downloadUrl>String</downloadUrl>
  <percentage>0</percentage>
  <requestDate>String</requestDate>
  <signedDownloadUrl>String</signedDownloadUrl>
  <status>String</status>
  <totalFailed>0</totalFailed>
  <totalResults>0</totalResults>
  <totalSucceeded>0</totalSucceeded>
  <type>String</type>
</GetTaskDetailResponse>