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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Task:
    # @ApiMember(Description="Async task ID", IsRequired=true)
    async_task_id: Optional[str] = None
    """
    Async task ID
    """


    # @ApiMember(Description="Type of requested async task, e.g 'stock', 'sellout', 'crm'", IsRequired=true)
    type: Optional[str] = None
    """
    Type of requested async task, e.g 'stock', 'sellout', 'crm'
    """


    # @ApiMember(Description="Async task creation date", IsRequired=true)
    request_date: Optional[str] = None
    """
    Async task creation date
    """


    # @ApiMember(Description="Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR'", IsRequired=true)
    status: Optional[str] = None
    """
    Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR'
    """


    # @ApiMember(Description="Percentage of completion", IsRequired=true)
    percentage: int = 0
    """
    Percentage of completion
    """


    # @ApiMember(Description="Brand Trigram", IsRequired=true)
    brand: Optional[str] = None
    """
    Brand Trigram
    """


    # @ApiMember(Description="Download url of created files")
    download_url: Optional[str] = None
    """
    Download url of created files
    """


    # @ApiMember(Description="Presigned expiring download url")
    signed_download_url: Optional[str] = None
    """
    Presigned expiring download url
    """


    # @ApiMember(Description="Total count of operations")
    total_results: Optional[int] = None
    """
    Total count of operations
    """


    # @ApiMember(Description="Count of successful operations")
    total_succeeded: Optional[int] = None
    """
    Count of successful operations
    """


    # @ApiMember(Description="Count of failed operations")
    total_failed: Optional[int] = None
    """
    Count of failed operations
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTaskDetailResponse(Task):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTaskDetail:
    # @ApiMember(Description="Async task ID", IsRequired=true)
    async_task_id: Optional[str] = None
    """
    Async task ID
    """

Python GetTaskDetail DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}