GET api/Progress/{taskProgressKey}

Request Information

URI Parameters

Name	Description	Type	Additional information
taskProgressKey		string	Required

Body Parameters

None.

Response Information

Resource Description

ProgressReport

Name	Type	Additional information
TotalResults	integer	None.
ProcessedResults	integer	None.
SuccessfulResults	integer	None.
IgnoredResults	integer	None.
FailedResults	integer	None.
ProgressMessage	TranslationMessage	None.
DisablePercentageProgress	boolean	None.
PercentageCompleted	decimal number	None.
IsCompleted	boolean	None.
TaskFailed	boolean	None.
ProgressCacheKey	string	None.
TimeElapsed	string	None.
TaskHasExpired	boolean	None.
HasErrors	boolean	None.
InformationMessages	Collection of GroupedTranslationMessages	None.
ErrorMessages	Collection of GroupedTranslationMessages	None.
DataFetchKey	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "ProcessedResults": 2,
  "SuccessfulResults": 3,
  "IgnoredResults": 4,
  "FailedResults": 5,
  "ProgressMessage": {
    "MessageKey": "sample string 1",
    "Message": "sample string 2",
    "MessageParams": {
      "sample string 1": {},
      "sample string 3": {}
    }
  },
  "DisablePercentageProgress": true,
  "PercentageCompleted": 0.0,
  "IsCompleted": true,
  "TaskFailed": true,
  "ProgressCacheKey": "sample string 9",
  "TimeElapsed": "sample string 10",
  "TaskHasExpired": true,
  "HasErrors": true,
  "InformationMessages": [
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    },
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    }
  ],
  "ErrorMessages": [
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    },
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    }
  ],
  "DataFetchKey": "sample string 12"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.