GET api/order/{orderId} Authentication required

Use this method to get an order's full details, including preview, mappings, options, history, etc

Request

URI Parameters

NameDescriptionTypeAdditional information
orderId

Id of the order

integer

Required

Response

Returns the full details of the order

Output : object (See Model)

Ouput Sample

  • application/json, text/json :
  • { "id": 1, "name": "sample string 2", "appUser": "sample string 3", "type": "sample string 4", "dataType": "sample string 5", "countryCode": "sample string 6", "creationDate": "2024-10-29T13:36:22.4209469+01:00", "modificationDate": "2024-10-29T13:36:22.4209469+01:00", "status": { "status": "sample string 1", "queuePosition": 2, "globalProgress": 3.1, "items": [ { "name": "sample string 1", "progress": 2.1 }, { "name": "sample string 1", "progress": 2.1 } ] }, "recordCount": 9, "fileName": "sample string 10", "finalFileName": "sample string 11", "reportFileName": "sample string 12", "headerInFirstRow": true, "rowDelimiter": "sample string 14", "columnDelimiter": "sample string 15", "trimCharacter": "sample string 16", "mappings": [ { "source": "sample string 1", "position": 2, "destination": "sample string 3" }, { "source": "sample string 1", "position": 2, "destination": "sample string 3" } ], "history": [ { "date": "2024-10-29T13:36:22.4209469+01:00", "status": "sample string 2", "message": "sample string 3" }, { "date": "2024-10-29T13:36:22.4209469+01:00", "status": "sample string 2", "message": "sample string 3" } ], "options": [ { "optionName": "sample string 1", "selected": true }, { "optionName": "sample string 1", "selected": true } ], "preview": [ { "columnName": "sample string 1", "columnPosition": 2, "values": [ "sample string 1", "sample string 2" ] }, { "columnName": "sample string 1", "columnPosition": 2, "values": [ "sample string 1", "sample string 2" ] } ] }