AgileApps Support Wiki

Difference between revisions of "REST API:import Mapping Profile Resource"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 216: Line 216:
:''Note:'' Unless otherwise indicated, the attribute for a field is "Editable on Add or Update".
:''Note:'' Unless otherwise indicated, the attribute for a field is "Editable on Add or Update".
:{| border="1" cellpadding="5" cellspacing="0"
:{| border="1" cellpadding="5" cellspacing="0"
! Name!!Type!!Attribute!!Required on Add!!Description!!Additional Information
! Name!!Type!!Attribute!!Required on Add/Update!!Description!!Additional Information
|-
|-
| id || String || align="center"|Read Only || || || [[Record Id]]
| id || String || align="center"|Read Only || || || [[Record Id]]
Line 242: Line 242:
|}
|}


;mapping Tag:
:{| border="1" cellpadding="5" cellspacing="0"
! Name!!Type!!Attribute!!Required on Add/Update!!Description!!Additional Information
|-
| column_name || Number || || || Number of CSV column  || The first column is column "zero"
|-
| csvColumnName || Attribute || || || Platform field name || This attribute of the column_name tag ties the platform's object field name to the CSV column number.
|}
;advancedOptions Tag:
:{| border="1" cellpadding="5" cellspacing="0"
:{| border="1" cellpadding="5" cellspacing="0"
! Name!!Type!!Attribute!!Required on Add!!Description!!Additional Information
! Name!!Type!!Attribute!!Required on Add!!Description!!Additional Information

Revision as of 00:15, 20 April 2012

Manage import Mapping Profiles using the REST API.

Learn more:

Permissions

Lock-tiny.gif

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
<syntaxhighlight lang="xml" enclose="div">

<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>
       0
       <description>Success</description>
   </message>
   <recordCount>N</recordCount>

</platform> </syntaxhighlight>

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
<syntaxhighlight lang="xml" enclose="div">

<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>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Add an Import Field-Mapping Profile

Method
POST
URI
https://{domain}/networking/rest/import/{objectName}
Request
<syntaxhighlight lang="xml" enclose="div">

<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> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>
       <id>...</id>   
   </message>

</platform> </syntaxhighlight>

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
<syntaxhighlight lang="xml" enclose="div">

<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> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

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
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

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/Update Description Additional Information
id String Read Only Record Id
name String Checkmark.gif Mapping profile name
description String
mapping ??? Checkmark.gif Describes the mapping betweeen the CSV columns and Platform fields.
advancedOptions Defines additional mapping profile options Checkmark.gif 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
mapping Tag
Name Type Attribute Required on Add/Update Description Additional Information
column_name Number Number of CSV column The first column is column "zero"
csvColumnName Attribute Platform field name This attribute of the column_name tag ties the platform's object field name to the CSV column number.
advancedOptions Tag
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:

Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=REST_API:import_Mapping_Profile_Resource&oldid=17146"