NSX-T Data Center REST API

ExportTask (type)

{
  "additionalProperties": false, 
  "description": "This object holds the information of the export task.", 
  "extends": {
    "$ref": "PolicyTask
  }, 
  "id": "ExportTask", 
  "module_id": "PolicyTask", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "async_response_available": {
      "display": {
        "order": 13
      }, 
      "readonly": true, 
      "title": "True if response for asynchronous request is available", 
      "type": "boolean"
    }, 
    "cancelable": {
      "display": {
        "order": 8
      }, 
      "readonly": true, 
      "title": "True if this task can be canceled", 
      "type": "boolean"
    }, 
    "description": {
      "display": {
        "order": 2
      }, 
      "readonly": true, 
      "title": "Description of the task", 
      "type": "string"
    }, 
    "draft_path": {
      "description": "Policy path of a draft if this is an export task to export draft configuration.", 
      "readonly": true, 
      "title": "Policy path of a draft", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "display": {
        "order": 6
      }, 
      "readonly": true, 
      "title": "The end time of the task in epoch milliseconds"
    }, 
    "exported_file": {
      "description": "Name of the exported file generated after completion of export task.", 
      "readonly": true, 
      "title": "Name of the exported file", 
      "type": "string"
    }, 
    "failure_msg": {
      "description": "This property holds the reason of the task failure, if any.", 
      "readonly": true, 
      "title": "Reason of the task failure", 
      "type": "string"
    }, 
    "id": {
      "display": {
        "order": 1
      }, 
      "readonly": true, 
      "title": "Identifier for this task", 
      "type": "string"
    }, 
    "message": {
      "display": {
        "order": 4
      }, 
      "readonly": true, 
      "title": "A message describing the disposition of the task", 
      "type": "string"
    }, 
    "progress": {
      "display": {
        "order": 7
      }, 
      "maximum": 100, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Task progress if known, from 0 to 100", 
      "type": "integer"
    }, 
    "request_method": {
      "display": {
        "order": 12
      }, 
      "readonly": true, 
      "title": "HTTP request method", 
      "type": "string"
    }, 
    "request_uri": {
      "display": {
        "order": 11
      }, 
      "readonly": true, 
      "title": "URI of the method invocation that spawned this task", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "display": {
        "order": 5
      }, 
      "readonly": true, 
      "title": "The start time of the task in epoch milliseconds"
    }, 
    "status": {
      "$ref": "TaskStatus, 
      "display": {
        "order": 3
      }, 
      "readonly": true, 
      "title": "Current status of the task"
    }, 
    "user": {
      "display": {
        "order": 10
      }, 
      "readonly": true, 
      "title": "Name of the user who created this task", 
      "type": "string"
    }
  }, 
  "title": "Export task information", 
  "type": "object"
}