GET api/Import/CustomImport/Get/{importGUID}
Gets all information about a custom import
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| importGUID | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Status message
ImportDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| FileName |
FileName with extension |
string |
Required |
| ImportFormat |
Custom Import Name |
string |
Required |
| DateCreated | date |
Nullable |
|
| ImportStatus | integer |
None. |
|
| DateImported | date |
Nullable |
|
| Detail | string |
None. |
|
| Rows | integer |
Nullable |
|
| Progress | integer |
Nullable |
|
| DateImportStarted | date |
Nullable |
|
| DateImportFinished | date |
Nullable |
|
| Disabled | boolean |
None. |
|
| ImportFormatVersion | date |
Nullable |
|
| IsPartial | boolean |
None. |
|
| Guid | globally unique identifier |
Nullable |
|
| FileData |
Byte Array of file data - used in import |
Collection of byte |
None. |
| DocumentId | globally unique identifier |
None. |
|
| PayrollId | globally unique identifier |
Nullable |
|
| SheetIds | Collection of globally unique identifier |
Nullable |
Response Formats
application/json, text/json
Sample:
{
"FileName": "sample string 1",
"ImportFormat": "sample string 2",
"DateCreated": "2024-12-23T06:09:35.6449242+00:00",
"ImportStatus": 3,
"DateImported": "2024-12-23T06:09:35.6449242+00:00",
"Detail": "sample string 4",
"Rows": 1,
"Progress": 1,
"DateImportStarted": "2024-12-23T06:09:35.6449242+00:00",
"DateImportFinished": "2024-12-23T06:09:35.6449242+00:00",
"Disabled": true,
"ImportFormatVersion": "2024-12-23T06:09:35.6449242+00:00",
"IsPartial": true,
"Guid": "5fc63522-529b-49b4-b073-07347c0dd457",
"FileData": "QEA=",
"DocumentId": "295f6d8a-0030-4c6d-ad67-3ea9767a3c2f",
"PayrollId": "2c3ee456-03c6-4c08-9871-e8c440757a86",
"SheetIds": [
"f0572616-8d0d-4797-896a-7b17969f4428",
"44732da5-6ab7-4a9a-8920-b14da9b23f1a"
]
}
application/xml, text/xml
Sample:
<ImportDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models">
<DateCreated>2024-12-23T06:09:35.6449242+00:00</DateCreated>
<DateImportFinished>2024-12-23T06:09:35.6449242+00:00</DateImportFinished>
<DateImportStarted>2024-12-23T06:09:35.6449242+00:00</DateImportStarted>
<DateImported>2024-12-23T06:09:35.6449242+00:00</DateImported>
<Detail>sample string 4</Detail>
<Disabled>true</Disabled>
<DocumentId>295f6d8a-0030-4c6d-ad67-3ea9767a3c2f</DocumentId>
<FileData>QEA=</FileData>
<FileName>sample string 1</FileName>
<Guid>5fc63522-529b-49b4-b073-07347c0dd457</Guid>
<ImportFormat>sample string 2</ImportFormat>
<ImportFormatVersion>2024-12-23T06:09:35.6449242+00:00</ImportFormatVersion>
<ImportStatus>3</ImportStatus>
<IsPartial>true</IsPartial>
<PayrollId>2c3ee456-03c6-4c08-9871-e8c440757a86</PayrollId>
<Progress>1</Progress>
<Rows>1</Rows>
<SheetIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:guid>f0572616-8d0d-4797-896a-7b17969f4428</d2p1:guid>
<d2p1:guid>44732da5-6ab7-4a9a-8920-b14da9b23f1a</d2p1:guid>
</SheetIds>
</ImportDetail>