REST API:import Mapping Profile Resource

Manage import field-mapping profiles using the REST API.

Learn more:

• bulk import Resource for importing data
• REST API Conventions and Considerations.

Permissions

Users that have the Manage Develop Features permission can use this resource.

List Import Field-Mapping Profiles

Method

GET

URI

https://{domain}/networking/rest/import/{objectName}/{mapping_profile_name}

Response

<platform>
    <mappingProfile>
        <id>1351233928</id>
        <name>TestMap</name>
        <description/>
        <objectId>e8dc7a31353947729c2d1995e3185771</objectId>
        <date_created>2012-03-14T04:59:39.000Z</date_created>
        <date_modified>2012-03-14T20:51:37.000Z</date_modified>
        <modified_id 
           type="" 
           uri="https://localhost/networking/rest/USER/1424089492" 
           displayValue="John Doe">1424089492</modified_id>
        <created_id          
           type="" 
           uri="https://localhost/networking/rest/USER/1424089492" 
           displayValue="John Doe">1424089492</created_id>
        <mapping>
            <energy csvColumnName="Energy (kWh)">2</lk>
            <numberField csvColumnName="Number">1</activiti_foreign_key>
        </mapping>
        <advancedOptions>
            <mergeOptions>MERGE_USING_PRIMARY_KEY</mergeOptions>
            <recordOwner          
               type="" 
               uri="https://localhost/networking/rest/USER/1424089492" 
               displayValue="John Doe">1424089492</recordOwner>
            <lookupFieldOptions>
                <lookupFieldOption lookupColumnName="Lk">time_field</lookupFieldOption>
            </lookupFieldOptions>
        </advancedOptions>
    </mappingProfile>

    <mappingProfile>
        ...
    </mappingProfile>
     ...

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>N</recordCount>      <!-- Number of mappingProfiles returned -->
</platform>

See also: REST API:Error Codes

Get an Import Field Mapping Profile

Method

GET

URI

https://{domain}/networking/rest/import/{objectName}/{mapping_profile_name}

Response

<platform>
    <mappingProfile>
        <id>1351233928</id>
        <name>TestMap</name>
        <description/>
        <objectId>e8dc7a31353947729c2d1995e3185771</objectId>
        <date_created>2012-03-14T04:59:39.000Z</date_created>
        <date_modified>2012-03-14T20:51:37.000Z</date_modified>
        <modified_id 
           type="" 
           uri="https://localhost/networking/rest/USER/1424089492" 
           displayValue="John Doe">1424089492</modified_id>
        <created_id          
           type="" 
           uri="https://localhost/networking/rest/USER/1424089492" 
           displayValue="John Doe">1424089492</created_id>
        <mapping>
            <energy csvColumnName="Energy (kWh)">2</lk>
            <numberField csvColumnName="Number">1</activiti_foreign_key>
        </mapping>
        <advancedOptions>
            <mergeOptions>MERGE_USING_PRIMARY_KEY</mergeOptions>
            <recordOwner          
               type="" 
               uri="https://localhost/networking/rest/USER/1424089492" 
               displayValue="John Doe">1424089492</recordOwner>
            <lookupFieldOptions>
                <lookupFieldOption lookupColumnName="Lk">time_field</lookupFieldOption>
            </lookupFieldOptions>
        </advancedOptions>
    </mappingProfile>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Add an Import Field-Mapping Profile

Method

POST

URI

https://{domain}/networking/rest/import/{objectName}

Request

<platform>
    <mappingProfile>
        <name>TestMap</name>
        <description/>
        <mapping>
            <energy csvColumnName="Energy (kWh)">2</lk>
            <numberField csvColumnName="Number">1</activiti_foreign_key>
        </mapping>
        <advancedOptions>
            <mergeOptions>MERGE_USING_PRIMARY_KEY</mergeOptions>
            <recordOwner 
                type="" uri="" 
                displayValue="Justin Thyme">d684f1b1ed754402b986364eeaa11417</recordOwner>
            <lookupFieldOptions>
                <lookupFieldOption lookupColumnName="Lk">time_field</lookupFieldOption>
            </lookupFieldOptions>
        </advancedOptions>
    </mappingProfile>
</platform>

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
        <id>...</id>   <!-- ID of the newly created mappingProfile -->
    </message>
</platform>

See also: REST API:Error Codes

Update an Import Field-Mapping Profile

Method

PUT

URI

https://{domain}/networking/rest/import/{objectName}/{mapping_profile_name}

Request

<platform>
    <mappingProfile>
        <name>TestMap</name>
        <description/>
        <mapping>
            <energy csvColumnName="Energy (kWh)">2</lk>
            <numberField csvColumnName="Number">1</activiti_foreign_key>
        </mapping>
        <advancedOptions>
            <mergeOptions>MERGE_USING_PRIMARY_KEY</mergeOptions>
            <recordOwner 
                type="" uri="" 
                displayValue="Justin Thyme">d684f1b1ed754402b986364eeaa11417</recordOwner>
            <lookupFieldOptions>
                <lookupFieldOption lookupColumnName="Lk">time_field</lookupFieldOption>
            </lookupFieldOptions>
        </advancedOptions>
    </mappingProfile>
</platform>

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Delete an Import Field Mapping Profile

Method

DELETE

URI

https://{domain}/networking/rest/import/{objectName}/{mapping_profile_name}

Record ID of the mapping profile can also be specified.

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Fields

Note: Unless otherwise indicated, the attribute for a field is "Editable on Add or Update".

Name	Type	Attribute	Required on Add	Description	Additional Information
id	String	Read Only			Record Id
name	String			Mapping profile name
description	String
mapping	???			Describes the mapping betweeen the CSV columns and Platform fields.
advancedOptions	Defines additional mapping profile options			description	AddlInfo
date_modified	Date	Read Only			UTC Format
date_created	Date	Read Only			UTC Format
created_id	Lookup	Read Only			User ID
modified_id	Lookup	Read Only			User ID

Name	Type	Attribute	Required on Add	Description	Additional Information
field	String			descr	addl info

Error Codes

Platform Code	with Http Status	Description
-52	INVALID_MAPPING_PROFILE_NAME
-53	PLEASE_PROVIDE_ADVANCED_MAPPING_OPTIONS
-54	INVALID_DEFAULT_OWNER_ID_SELECTED
-55	INVALID_MERGE_OPTION_FOR_ACCOUNTS
-56	INVALID_PROPSECT_OWNER_ASSIGNMENT_OPTION
-57	FIELD_IN_MAPPED_COLUMNS_DOES_NOT_EXIST
-58	INVALID_CSV_COLUMN_NUMBER

Learn more:

• See the REST API:Error Codes for common Http error codes
• See the javadoc constants for a complete list of PlatformException error-code constants.