Jump to

• Request
• Response
• Examples

Create a file import map

post

/crmRestApi/resources/11.13.18.05/importMappings

Request

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 250

  A brief description of the import mapping.
• ImportMappingColumns: array Import Activity Map Columns
  Title: Import Activity Map Columns

  The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.
• MappingNumber: string
  Title: Mapping Number

  Maximum Length: 130

  The alternate key identifier of the import mapping.
• Name(required): string
  Title: File Import Mapping

  Maximum Length: 100

  The name of the import mapping.
• ObjectCode(required): string
  Title: Object

  Maximum Length: 100

  The code indicating the type of object imported using the optimized Import option. For example, Accounts, Contacts, or Opportunities.

{
    "required":[
        "Name",
        "ObjectCode"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"A brief description of the import mapping.",
            "nullable":true
        },
        "ObjectCode":{
            "title":"Object",
            "maxLength":"100",
            "type":"string",
            "description":"The code indicating the type of object imported using the optimized Import option. For example, Accounts, Contacts, or Opportunities.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MappingNumber":{
            "title":"Mapping Number",
            "maxLength":"130",
            "type":"string",
            "description":"The alternate key identifier of the import mapping.",
            "nullable":false
        },
        "ImportMappingColumns":{
            "title":"Import Activity Map Columns",
            "type":"array",
            "description":"The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.",
            "items":{
                "$ref":"#/components/schemas/importMappings-ImportMappingColumns-item-post-request"
            }
        },
        "Name":{
            "title":"File Import Mapping",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the import mapping.",
            "nullable":false
        }
    }
}

Nested Schema : Import Activity Map Columns

Type: array

Title: Import Activity Map Columns

The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.

Show Source

• Array of: object schema

{
    "title":"Import Activity Map Columns",
    "type":"array",
    "description":"The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.",
    "items":{
        "$ref":"#/components/schemas/importMappings-ImportMappingColumns-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "title":"Attribute Name",
            "type":"string",
            "description":"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 .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ColumnHeader":{
            "title":"Column Header",
            "maxLength":"500",
            "type":"string",
            "description":"The column header name in the CSV source file.",
            "nullable":false
        },
        "Ignore":{
            "title":"Ignore",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source file column header values should be ignored during import or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExampleValue":{
            "title":"Example Value",
            "maxLength":"100",
            "type":"string",
            "description":"An example value for the respective source file column.",
            "nullable":true
        },
        "AttributeDisplayName":{
            "title":"Attribute Display Name",
            "type":"string",
            "description":"The import object attribute display name mapped to the source file column header.",
            "nullable":true
        },
        "MappingColumnNumber":{
            "title":"Mapping Column Number",
            "maxLength":"160",
            "type":"string",
            "description":"The alternate key identifier of the import mapping column.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : importMappings-item-response

Type: object

Show Source

• 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.
• Description: string
  Title: Description

  Maximum Length: 250

  A brief description of the import mapping.
• ImportMappingColumns: array Import Activity Map Columns
  Title: Import Activity Map Columns

  The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.
• 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.
• MappingNumber: string
  Title: Mapping Number

  Maximum Length: 130

  The alternate key identifier of the import mapping.
• Name: string
  Title: File Import Mapping

  Maximum Length: 100

  The name of the import mapping.
• ObjectCode: string
  Title: Object

  Maximum Length: 100

  The code indicating the type of object imported using the optimized Import option. For example, Accounts, Contacts, or Opportunities.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"A brief description of the import mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportMappingColumns":{
            "title":"Import Activity Map Columns",
            "type":"array",
            "description":"The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.",
            "items":{
                "$ref":"#/components/schemas/importMappings-ImportMappingColumns-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectCode":{
            "title":"Object",
            "maxLength":"100",
            "type":"string",
            "description":"The code indicating the type of object imported using the optimized Import option. For example, Accounts, Contacts, or Opportunities.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MappingNumber":{
            "title":"Mapping Number",
            "maxLength":"130",
            "type":"string",
            "description":"The alternate key identifier of the import mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"File Import Mapping",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the import mapping.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Import Activity Map Columns

Type: array

Title: Import Activity Map Columns

The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.

Show Source

• Array of: object importMappings-ImportMappingColumns-item-response

{
    "title":"Import Activity Map Columns",
    "type":"array",
    "description":"The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.",
    "items":{
        "$ref":"#/components/schemas/importMappings-ImportMappingColumns-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : importMappings-ImportMappingColumns-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "title":"Attribute Name",
            "type":"string",
            "description":"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 .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ColumnHeader":{
            "title":"Column Header",
            "maxLength":"500",
            "type":"string",
            "description":"The column header name in the CSV source file.",
            "nullable":false,
            "x-queryable":true
        },
        "Ignore":{
            "title":"Ignore",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source file column header values should be ignored during import or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExampleValue":{
            "title":"Example Value",
            "maxLength":"100",
            "type":"string",
            "description":"An example value for the respective source file column.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDisplayName":{
            "title":"Attribute Display Name",
            "type":"string",
            "description":"The import object attribute display name mapped to the source file column header.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingColumnNumber":{
            "title":"Mapping Column Number",
            "maxLength":"160",
            "type":"string",
            "description":"The alternate key identifier of the import mapping column.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ImportMappingColumns

Operation: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns

Parameters:

• MappingNumber: $request.path.MappingNumber

The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.

ImportObjectsVA

Operation: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata

Parameters:

• finder: objectRowFinder

The import export object metadata resource is used to view the objects which support for file-based import and export.

Back to Top

Examples

The following example shows how to create a file import map by submitting a POST 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

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "Name" : "Acc_MAT_delay_WarningLink",
  "Description" : null,
  "ObjectCode" : "Account" 
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "MappingNumber" : "300100123776040",
  "Name" : "Acc_MAT_delay_WarningLink",
  "ObjectCode" : "Account",
  "Description" : null,
  "CreationDate" : "2017-11-02T13:22:04.178+00:00",
  "CreatedBy" : "MHoope",
  "LastUpdateDate" : "2017-11-02T14:35:50+00:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateLogin" : "5D01E1EBD5DB6C3EE053768DF50A9500"
  }

Back to Top