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
namespace Richemont.Booster2.PublicApi.NightlyProcess.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Task() = 
        ///<summary>
        ///Async task ID
        ///</summary>
        [<ApiMember(Description="Async task ID", IsRequired=true)>]
        member val asyncTaskId:Guid = new Guid() with get,set

        ///<summary>
        ///Type of requested async task, e.g 'stock', 'sellout', 'crm'
        ///</summary>
        [<ApiMember(Description="Type of requested async task, e.g 'stock', 'sellout', 'crm'", IsRequired=true)>]
        member val type:String = null with get,set

        ///<summary>
        ///Async task creation date
        ///</summary>
        [<ApiMember(Description="Async task creation date", IsRequired=true)>]
        member val requestDate:String = null with get,set

        ///<summary>
        ///Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR'
        ///</summary>
        [<ApiMember(Description="Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR'", IsRequired=true)>]
        member val status:String = null with get,set

        ///<summary>
        ///Percentage of completion
        ///</summary>
        [<ApiMember(Description="Percentage of completion", IsRequired=true)>]
        member val percentage:Int32 = new Int32() with get,set

        ///<summary>
        ///Brand Trigram
        ///</summary>
        [<ApiMember(Description="Brand Trigram", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///Download url of created files
        ///</summary>
        [<ApiMember(Description="Download url of created files")>]
        member val downloadUrl:String = null with get,set

        ///<summary>
        ///Presigned expiring download url
        ///</summary>
        [<ApiMember(Description="Presigned expiring download url")>]
        member val signedDownloadUrl:String = null with get,set

        ///<summary>
        ///Total count of operations
        ///</summary>
        [<ApiMember(Description="Total count of operations")>]
        member val totalResults:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Count of successful operations
        ///</summary>
        [<ApiMember(Description="Count of successful operations")>]
        member val totalSucceeded:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Count of failed operations
        ///</summary>
        [<ApiMember(Description="Count of failed operations")>]
        member val totalFailed:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type GetTaskDetailResponse() = 
        inherit Task()

    [<AllowNullLiteral>]
    type GetTaskDetail() = 
        ///<summary>
        ///Async task ID
        ///</summary>
        [<ApiMember(Description="Async task ID", IsRequired=true)>]
        member val asyncTaskId:Guid = new Guid() with get,set

F# 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>