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 Foundation
import ServiceStack

public class GetTaskDetail : Codable
{
    /**
    * Async task ID
    */
    // @ApiMember(Description="Async task ID", IsRequired=true)
    public var asyncTaskId:String

    required public init(){}
}

public class GetTaskDetailResponse : Task
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class Task : Codable
{
    /**
    * Async task ID
    */
    // @ApiMember(Description="Async task ID", IsRequired=true)
    public var asyncTaskId:String

    /**
    * 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 var type:String

    /**
    * Async task creation date
    */
    // @ApiMember(Description="Async task creation date", IsRequired=true)
    public var requestDate:String

    /**
    * 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 var status:String

    /**
    * Percentage of completion
    */
    // @ApiMember(Description="Percentage of completion", IsRequired=true)
    public var percentage:Int

    /**
    * Brand Trigram
    */
    // @ApiMember(Description="Brand Trigram", IsRequired=true)
    public var brand:String

    /**
    * Download url of created files
    */
    // @ApiMember(Description="Download url of created files")
    public var downloadUrl:String

    /**
    * Presigned expiring download url
    */
    // @ApiMember(Description="Presigned expiring download url")
    public var signedDownloadUrl:String

    /**
    * Total count of operations
    */
    // @ApiMember(Description="Total count of operations")
    public var totalResults:Int?

    /**
    * Count of successful operations
    */
    // @ApiMember(Description="Count of successful operations")
    public var totalSucceeded:Int?

    /**
    * Count of failed operations
    */
    // @ApiMember(Description="Count of failed operations")
    public var totalFailed:Int?

    required public init(){}
}


Swift 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
}