POST api/Download/CancelConvertTask

Cancel the file transformation task

Request Information

URI Parameters

None.

Body Parameters

ObjResultOfString
NameDescriptionTypeAdditional information
Data

string

None.

Error

Error description if the operation failed

string

None.

Success

Operation result

boolean

None.

ErrorCode

Error code

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "data": "sample string 1",
  "error": "sample string 2",
  "success": true,
  "errorCode": 4
}

application/xml, text/xml

Sample:
<ObjResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>4</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 2</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
  <Data>sample string 1</Data>
</ObjResultOfstring>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ObjResult`1'.

Response Information

Resource Description

Returns true if the cancellation was successfully done (check Data), False if an error occured (check Error)

ObjResultOfBoolean
NameDescriptionTypeAdditional information
Data

boolean

None.

Error

Error description if the operation failed

string

None.

Success

Operation result

boolean

None.

ErrorCode

Error code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "data": true,
  "error": "sample string 2",
  "success": true,
  "errorCode": 4
}

application/xml, text/xml

Sample:
<ObjResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>4</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 2</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
  <Data>true</Data>
</ObjResultOfboolean>
bool hasModels = Model.ParameterModels.Count > 0; if (hasModels) {

Parameter Information

code

Property Description
Data (String)

				
Error (String)
            Error description if the operation failed
            
Success (Boolean)
            Operation result
            
ErrorCode (Int32)
             Error code
            
}