ROSEPEOPLE Developers - Web API Reference

People | Data Exporter

Overview


URL api/{tenantKey}/{orgKey}/peopleCore/dataExporters
Methods Supported GET, POST

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Data Exporter

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.

The following elements are optional:

company (string) Company This is a query string parameter.

Response:

When successful, the response body contains the list of entity records available for processing. See ExportDataDetail.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /peopleCore/dataExporters/{pageIndex}/{pageSize}?company={company}

POST Operations

POST Data Exporter

Instructs the 'Professions' service to process the specified entity records.

The following elements are required:

list (ExportDataDetail) List of the entity records that should be processed.
See ExportDataDetail.
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:

POST /peopleCore/dataExporters/{companyKey}

Resources


ExportDataDetail

The following elements are required:

selected (bool) Selected.

The following elements are optional:

key (string) Key.
description (string) Description.


ExportDataMain

The following elements are required:

selectedCount (int) Selected Count.
entity (string) Entity.

The following elements are optional:

company (string) Company.