The first row of the worksheet must include the field names as the column headers. Hiperos 3PM Quick Integration reads this text to import the data to the appropriate fields. NOTE: When importing setup data values, the setup code must be used rather than the display name.
Note: Required fields are marked with an asterisk (*).
Field | Description |
---|---|
TypeCode (*) | Must match an existing code under Setup Data Management. |
DataCode (*) | Enter the data code. |
DisplayName (*) | Enter the display name presented to the user. |
Culture | Enter the language of the setup data. |
ParentCode | Must match an existing parent code under Setup Data Management. |
OrderNumber | Enter the row order number. This is the place where the new setup data displays. |
Description | Enter a short description of the setup data. |
Activated (*) | Enter Yes to activate the organization. |
ActivateDate | Enter the date the setup data is active. |
ScoreValue | Enter the score value of the setup data element. |
Valid credentials must be supplied for each Hiperos 3PM Quick Integration request issued in order to succeed.
The 3PM user supplied must be a member of either the 'QuickIntegration' group or the 'QuickIntegration-SetupData' group. The QuickIntegration group allows an account to access all Quick Integration resources. The QuickIntegration-SetupData group limits access to only the Quick Integration SetupData resource. If these groups currently do not exist in your Hiperos 3PM instance, please contact your local 3PM administrator or your Hiperos Customer Services representative to have them created.
HTTP Header | Description |
---|---|
username | Valid Hiperos 3PM Username |
password | Valid Hiperos 3PM Password |
The content type header must contain one of the following types listed below. This is used to identify the file format that is being uploaded. Note: If sending data as an octet-stream, filename is required in the Content-Disposition header.
Content Type Header | File Type |
---|---|
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Excel 2007 or later versions (xlsx) |
application/vnd.ms-excel | Excel 2003 or earlier versions (xls) |
text/csv | Comma separated values (csv) |
application/octet-stream |
File format determined by filename value in Content-Disposition e.g. Content-Disposition: form-data; name="file"; filename="user_import.xlsx" |
Status Code | Result | Description |
---|---|---|
201 | Created | New objects succesfully created. |
202 | Accepted | Data has been queued for import (system-generated e-mail confirmation to follow). |
204 | No Content | No new or updated data to import was found or the file was not in the correct format. |
400 | Bad Request | Problem rows and/or columns were found. Review returned validation message in response. |
401 | Unauthorized | Username & password http headers were not found in the request. |
403 | Forbidden | Login failed, was not found or not authorized. |
500 | Server Error | Failed to save import data to database. |