GET Data Loader
Returns the list of entity records that can be processed by the 'Professions' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| entity | (string) Entity. |
| loadLocation | (LoadLocation) Load Location. |
The following elements are optional:
| search | (string) Search This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
| fileData | (string) File Data This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See LoadDataDetail. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/peopleCore/dataLoaders/{pageIndex}/{pageSize}?search={search}&company={company}&fileData={fileData}
GET /peopleCore/dataLoaders/{pageIndex}/{pageSize}?search={search}&company={company}&fileData={fileData}
POST Import Item
Load item data from API.
The following elements are required:
| entity | (string) The entity key to load data. |
| code | (string) The lítem key to load into database. |
| company | (string) The company key for CompanyDependant entities. |
Response:
| When successful, the response body is empty. |
Resource URL:
api/{tenantKey}/{orgKey}/peopleCore/dataLoaders/importItem/{entity}/{code}
POST /peopleCore/dataLoaders/importItem/{entity}/{code}
POST Data Loader
Instructs the 'Professions' service to process the specified entity records.
The following elements are required:
| list | (LoadDataDetail) List of the entity records that should be processed. See LoadDataDetail. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/peopleCore/dataLoaders/{companyKey}
POST /peopleCore/dataLoaders/{companyKey}
Resources
LoadDataDetail
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| key | (string) Key. |
| description | (string) Description. |
| localFile | (bool) Local File. |
LoadDataMain
The following elements are required:
| selectedCount | (int) Selected Count. |
| entity | (string) Entity. |
| loadLocation | (enum LoadLocation) Load Location.
See LoadLocation. |
The following elements are optional:
| search | (string) Search. |
| company | (string) Company. |
| fileData | (string) File Data. |