AgileApps Support Wiki

REST API:import Mapping Profile Resource

From AgileApps Support Wiki
Revision as of 23:37, 19 April 2012 by imported>Aeric

Manage import field-mapping profiles using the REST API.

Learn more: REST API Conventions and Considerations.

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}
Return all fields
URI
https://{domain}/networking/rest/import/{objectName}/{mapping_profile_name}?{query_parameters}
Query Parameters
Introductory sentence, if any
  • parameter1 - Description
  • parameter2
  • If TRUE, ...
  • If FALSE, ...
For more information, see: Specifying Query Parameters in REST APIs
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>
       <field>data</field>
        ...
   </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>
       <id>{recordId}</id>
        ...
   </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}
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 Description Additional Information
id String Read Only Record Id
name String Checkmark.gif
description String
... ... ... ... ... ...
tag String Read Only description AddlInfo
tag String description AddlInfo
tag String Checkmark.gif description AddlInfo
tag String Writable on Add only 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

-or-

Name Type Attribute Default Value Description Additional Information
tag String Read Only Default description AddlInfo
tag String Default 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

Error Codes

Platform Code with Http Status Description
-7000 BAD_REQUEST (400) Invalid index name

Learn more:

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