Represents a CSV import (typically from a HR system) containing persona identifiers and their attributes.
It is accessible through the following HTTP interfaces:
Connection HTTP Interface via http://www.example.org/api/connection/personasImport.
REST HTTP Interface via http://www.example.org/api/v2/personasImport.
...
Create the persona import model via the REST HTTP Interface (http://www.example.org/api/v2/personasImport).
Upload the CSV via the Upload HTTP interface.
Process the persona import model via the Process HTTP interface.
Alternatively, you can create/update personas via the Persona Upsert HTTP Interface.
SCHEMA
Name | Description |
|---|---|
_id | The id of this persona import model. |
organisation | The id of the organisation this persona import belongs to. |
owner | The id of the user that created the persona import. |
title | The title of this persona import. |
csvHeaders | An array of the header names from the CSV. |
structure | The structure of the CSV. |
importedAt | The date and time that the persona import was imported. |
csvHandle | The location of the CSV file in the storage provider. |
csvErrorHandle | The location of the CSV file with its errors in the storage provider. |
totalCount | Total number of data rows in the CSV. |
processedCount | Total number of processed data rows in the CSV. |
importErrors | An array of the errors in the CSV. |
result | The result of the import in terms of personas created and merged. |
...
Name | Description |
|---|---|
columnName | The name of the column in the CSV (CSV header). |
The type of the column or how it should be parsed. | |
relatedColumn | For account names this is the account home page column, for account home pages this is the account name column. |
primary | Defines the order in which identifiers should be used. |
...
To retrieve the persona that was created/updated in the previous upsert request, you can make the following request to the Connection HTTP Interface for Persona Indentifiers.
| Code Block |
|---|
GET http://www.example.org/api/connection/personaidentifier?filter={"ifi.key": "account", "ifi.value.homePage": "https://sso.example.org", "ifi.value.name": "sam_jackson_sso_id"}
Authorization: <YOUR_BASIC_AUTH_TOKEN>
|
...