Create a file import map column
post
/crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns
Request
Path Parameters
-
MappingNumber(required): string
The alternate key identifier of the import mapping.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AttributeCode: string
Title:
Attribute Name
The code indicating the type of the attribute mapped to the source file column header. A list of valid values is defined in the lookup FUSION.ZCA_OBJECT_ATTRIBUTES . -
AttributeDisplayName: string
Title:
Attribute Display Name
The import object attribute display name mapped to the source file column header. -
ColumnHeader: string
Title:
Column Header
Maximum Length:500
The column header name in the CSV source file. -
ExampleValue: string
Title:
Example Value
Maximum Length:100
An example value for the respective source file column. -
Ignore: string
Title:
Ignore
Maximum Length:1
Indicates whether the source file column header values should be ignored during import or not. -
MappingColumnNumber: string
Title:
Mapping Column Number
Maximum Length:160
The alternate key identifier of the import mapping column.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : importMappings-ImportMappingColumns-item-response
Type:
Show Source
object
-
AttributeCode: string
Title:
Attribute Name
The code indicating the type of the attribute mapped to the source file column header. A list of valid values is defined in the lookup FUSION.ZCA_OBJECT_ATTRIBUTES . -
AttributeDisplayName: string
Title:
Attribute Display Name
The import object attribute display name mapped to the source file column header. -
ColumnHeader: string
Title:
Column Header
Maximum Length:500
The column header name in the CSV source file. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
ExampleValue: string
Title:
Example Value
Maximum Length:100
An example value for the respective source file column. -
Ignore: string
Title:
Ignore
Maximum Length:1
Indicates whether the source file column header values should be ignored during import or not. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Updated
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingColumnNumber: string
Title:
Mapping Column Number
Maximum Length:160
The alternate key identifier of the import mapping column.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ImportObjectAttrsVA
-
Parameters:
- finder:
objectRowFinder
The import export object metadata resource is used to view the objects which support for file-based import and export. - finder:
- YNLookupVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindCurrentDate%3D2024-05-17%2CBindLookupType%3DMKT_YES_NO
The lookups resource is used to view standard lookup codes. - finder:
Examples
The following example shows how to create a file import map column by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/importMappings/300100123776040/child/ImportMappingColumns
Example of Request Body
The following shows an example of the request body in JSON format.
{ "ColumnHeader" : "OrganizationName", "ExampleValue" : "Org", "AttributeCode" : "OrganizationName" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "ColumnHeader" : "OrganizationName", "ExampleValue" : "Org", "AttributeCode" : "OrganizationName", "AttributeDisplayName" : "Comments", "MappingColumnNumber" : "300100123776036", "Ignore" : "N", "CreationDate" : "2017-11-02T13:22:04.292+00:00", "CreatedBy" : "MHoope", "LastUpdateDate" : "2017-11-02T15:01:49+00:00", "LastUpdatedBy" : "SALES_ADMIN", "LastUpdateLogin" : "5D00CDF67DF8656CE053768DF50A4CED", "links": [ ... ] }