Jump to

• Request
• Response

Get the status of the file import task

get

/rest/{versionId}/routeSets/{routeSetId}/importFile/{taskId}

Use this (GET) method to see the status of CSV file import task. User needs to provide the route set Id and import task Id of the import task to know the status.

Request

Path Parameters

• routeSetId: string
  The route set Id on which import task is running.
• taskId: string
  The task Id of file import task.
• versionId: string
  The rest api version, it's value is v1.3.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : importStatus

Type: object

Show Source

• addedCount(optional): string
• deletedCount(optional): string
• errorCount(optional): string
• errorList(optional): array errorList
• finished(optional): string
• rowsProcessedCount(optional): string
• taskId(optional): string
• totalRowsCount(optional): string

{
    "properties":{
        "addedCount":{
            "type":"string"
        },
        "deletedCount":{
            "type":"string"
        },
        "errorCount":{
            "type":"string"
        },
        "errorList":{
            "items":{
                "$ref":"#/definitions/RestImportTaskError",
                "xml":{
                    "name":"error"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "finished":{
            "type":"string"
        },
        "rowsProcessedCount":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "totalRowsCount":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"importStatus"
    }
}

Nested Schema : errorList

Type: array

Show Source

• Array of: object error

{
    "items":{
        "$ref":"#/definitions/RestImportTaskError",
        "xml":{
            "name":"error"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : error

Type: object

Show Source

• csvRowData(optional): string
• failureReason(optional): string

{
    "properties":{
        "csvRowData":{
            "type":"string"
        },
        "failureReason":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"error"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error

Back to Top