Jump to: navigation, search

importProfileRecords

Purpose

Imports several customer profiles in a single operation. Your application should use this operation if you need to import a large number of profiles into the UCS database. Note that TenantId and Segment columns are not compulsory. If omitted, default values are used.

URL

  • POST /profiles/import

Request

HTTP Headers

Key ValueType Value Description Mandatory Unique Default
X-Genesys-TenantId Integer Integer value of tenant id false true
X-Genesys-Segment String Segment value (not to be provided by customer) false true


Body

Key ValueType Value Description Mandatory Unique Default
format String Defines the format of the submitted data. Only "CSV" value is supported false true
profiles String File path, for instance 'C:/profiles.csv'. File path, for instance 'C:/profiles.csv'.

Your application is responsible for uploading the file on the server's local filesystem.

false true
id-key String A valid identification key." If specified, the server checks to see whether the profile already exists prior to the insertion.

If the profile does exist in the database, the record containing the duplicate profile is skipped.

false true
delimiter String Defines the character used to separate the submitted profiles:
  char or "," by default.
false true
max-errors String The number of errors to allow before ending the bulk load.

An error can indicate that a given record was not parsed correctly, or that an ambiguity exists with an existing customer record (see response below).

false true
encoding String Encoding character to use for file import.

Default is UTF-8<ref> UTF-8 without BOM, see related bug

false true
start-from-index String The record number from which to start importing. false true
create-log Boolean This flag turns extended import results logging on or off.

The log data is written to an output file that has the same name as the input file, with an extension of .log appended. The default value is false.

false true

Sample

POST /profiles/import
--zaHf8xb3LfVOXZ0o2KUyqWD4Zlfumh0R9uyMN
Content-Disposition: form-data; name="description"
Content-Type: application/json; charset=UTF-8
Content-Transfer-Encoding: 8bit
 
{"delimiter":",","profiles":"D:/successContentProfiles.csv","format":"csv","max-errors":20}
--zaHf8xb3LfVOXZ0o2KUyqWD4Zlfumh0R9uyMN--Example of CSV content:
   TenantId,Segment,FirstName,LastName,​PhoneNumber[2],PhoneNumber[1],​EmailAddress,Address.AddressType,Address.​PostCode,Address.Address,Address.County,​Address.City,Address.Country   101,not-applicable,elintakiev,​baschambrissi,01-357-296-3696,11-213-036-1987,selinta@ebaschambrissi.​net,0,6910,qwe,Tucson,Lithuania,Ocala

Responses

Success

ReturnCode ReturnString Description
200 OK Request successful

Error

FaultCode FaultString Description
400 Bad Request General error which can be one of the following reasons:
  • Missing required parameter.
  • Parameter value of unexpected type.
  • Invalid object syntax.
  • Missing required attribute
401 Not Authorized Credentials are missing or incorrect, or the given user is not allowed to execute a given service (such as an administrative service method that changes the profile schema).
403 Forbidden The operation is forbidden and the reason is specified in the error message. This error is returned in the following cases:
  • Attempt to add customer profiles prior to the definition of a profile schema.
404 Not Found The specified URI is invalid, or the requested resource (such as a customer, service, state, task, extension, or identification key) does not exist.
405 Method Not Allowed Returned when an unsupported operation is requested. For instance, if a resource supports only PUT and GET operations, a POST request on this resource returns this error.
415 Unsupported Media Type In the header of your request, Content-Type is not set to a valid value. Most operations of Context Services support only "application/json".

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.