SEI Developer Portal | Mapping Utility

Mapping Utility

GET

/{systemName}

Returns all the integration mapping data for a particular system.

Prod:

https://api.seic.com/v1/mappingUtility/{systemName}

Query Parameters

Name	Description	Data Type	Required
configExternalId		string

Header Parameters

Name	Description	Data Type	Required
Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".	string
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.	string

Path Parameters

Name	Description	Data Type	Required
systemName	The system for which the mapping utility will provide field mapping data. Valid value is crm.	string

HTTP Responses

Code

Description
200

OK- The request has succeeded and the response has been returned.
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

configExternalId

Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Mapping Utility

GET

/{systemName}

Returns all the integration mapping data for a particular system.

Prod:

https://api.seic.com/v1/mappingUtility/{systemName}

Query Parameters

Name	Description	Data Type	Required
configExternalId		string

Header Parameters

Name	Description	Data Type	Required
Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".	string
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.	string

Path Parameters

Name	Description	Data Type	Required
systemName	The system for which the mapping utility will provide field mapping data. Valid value is crm.	string

HTTP Responses

Code

Description
200

OK- The request has succeeded and the response has been returned.
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

configExternalId

Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v1/mappingUtility/{systemName}

TLS*: https://mtls.api.seic.com/v1/mappingUtility/{systemName}

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 2

Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

Mapping Utility

GET

/{systemName}

Returns all the integration mapping data for a particular system.

Prod:

https://api.seic.com/v1/mappingUtility/{systemName}

Query Parameters

Name	Description	Data Type	Required
configExternalId		string

Header Parameters

Name	Description	Data Type	Required
Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".	string
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.	string

Path Parameters

Name	Description	Data Type	Required
systemName	The system for which the mapping utility will provide field mapping data. Valid value is crm.	string

HTTP Responses

Code

Description
200

OK- The request has succeeded and the response has been returned.
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

configExternalId

Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X GET \
  https://api.seic.com/v1/mappingUtility/crm \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \

REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH

REQUEST PAYLOAD MODEL

RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9

SAMPLE RESPONSE

{
  "data": {
    "salesforceDataSyncProcess": [
      {
        "sourceObjectName": "'https://api.seic.com/v1/investors/standard?active=true",
        "sourceObjectType": "API",
        "dbConnectionKey": "Default",
        "targetApiFileType": "JSON",
        "order": 1,
        "targetApiObject": "Investor_Account__c",
        "upsertKeyField": "Investor_Code__c",
        "processKey": "",
        "bulkApiColumns": [
          {
            "sourceColumnName": "externalId",
            "sourceParentColumnName": null,
            "isSourceColumnArray": false,
            "sourceColumnArrayFilterName": null,
            "sourceColumnArrayFilterValue": null,
            "destinationColumnName": "Investor_Code__c",
            "columnOrder": 1,
            "maxLength": 0
          },
          {
            "sourceColumnName": "fullName",
            "sourceParentColumnName": null,
            "isSourceColumnArray": false,
            "sourceColumnArrayFilterName": null,
            "sourceColumnArrayFilterValue": null,
            "destinationColumnName": "Investor_Name__c",
            "columnOrder": 2,
            "maxLength": 0
          },
          {
            "sourceColumnName": "primaryTaxId",
            "sourceParentColumnName": "pii",
            "isSourceColumnArray": false,
            "sourceColumnArrayFilterName": null,
            "sourceColumnArrayFilterValue": null,
            "destinationColumnName": "Investor_Tax_ID__c ",
            "columnOrder": 3,
            "maxLength": 0
          },
          {
            "sourceColumnName": "countryIsoCode",
            "sourceParentColumnName": "address",
            "isSourceColumnArray": true,
            "sourceColumnArrayFilterName": "type",
            "sourceColumnArrayFilterValue": "Legal",
            "destinationColumnName": "Investor_Legal_Country__c ",
            "columnOrder": 4,
            "maxLength": 0
          }
        ],
        "parameters": [],
        "enabled": true
      }
    ],
    "bulkRequestSize": 10000,
    "bulkApiVersion": "34.0"
  }
}

MODEL

Operations

Name	Description	Data Type (L)
salesforceDataSyncProcess	An array of configuration fields and data mapping necessary to support integration between two systems.	array
dbConnectionKey	Database key.	string
targetApiObject	The target API object that the data will be transmitted to via a POST call.	string
upsertKeyField	Upsert key.	string
processKey	Process key.	string
bulkAPIColumns	An array of source and destination field mapping pairs.	array
sourceColumnName	Source column name within the stored procedure or API call.	string
destinationColumnName	Destination column name within the stored procedure or API call.	string
columnOrder	Sort order of columns.	string
maxLength	Maximum allowable length.	string
parameterName	Name of the parameter for the stored procedure or API.	string
parameterValue	Value of the parameter for the stored procedure or API.	string
enabled	Identifies whether the mapping is enabled. true/false	string
bulkRequestSize	The size of the request.	string
bulkApiVersion	Version of the API.	string
sourceObjectName	Specifies the API URL or stored procedure name used as the source for the process mapping.	string
sourceObjectType	Identifies if the sourceObjectName (ie data source) is an ‘API’ or a ‘StoredProcedure’.	string
targetApiFileType	Identifies the format of the source output as either ‘JSON’ or ‘CSV’.	string
order	A single mapping configuration can be a collection of individual processes. The Order field identifies the sequence in which each process should be run with 1 being first. This is useful when there is a data dependency across the processes in a single mapping configuration.	string
sourceParentColumnName	When the field being mapped is contained in an object, the object name must be specified.	string
isSourceColumnArray	When the field being mapped is part of an array, isSourceColumnArray is ‘true’, otherwise it’s ‘false’. This tells the mapping utility how to interpret the response to build the output file.	TRUE
sourceColumnArrayFilterName	When the data being mapped is part of an array, the sourceColumnArrayFilterName is used to define filter criteria for mapping specific values to different destination fields. It is used in conjunction with sourceColumnArrayFiltervalue. Example: Investor Address is an array containing address types of Legal and Mailing address. sourceColumnArrayFilterName=type will allow mapping Legal address to one destination and Mailing address to another.	string
sourceColumnArrayFilterValue	When the data being mapped is part of an array, the sourceColumnArrayFilterValue is used to define filter criteria for mapping specific values to different destination fields. It is used in conjunction with sourceColumnArrayFilterName. Example: Investor Address is an array containing address types of Legal and Mailing address. sourceColumnArrayFilterValue=Mailing will allow mapping Mailing address to one destination and Legal address to another.	string
parameterType		string
parameters	The conditions that we need to supply in order to run a report	string

Mapping Utility

GET

/{systemName}

Returns all the integration mapping data for a particular system.

Prod:

https://api.seic.com/v1/mappingUtility/{systemName}

Query Parameters

Name	Description	Data Type	Required
configExternalId		string

Header Parameters

Name	Description	Data Type	Required
Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".	string
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.	string

Path Parameters

Name	Description	Data Type	Required
systemName	The system for which the mapping utility will provide field mapping data. Valid value is crm.	string

HTTP Responses

Code

Description
200

OK- The request has succeeded and the response has been returned.
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

configExternalId

Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Mapping Utility

GET

/{systemName}

Returns all the integration mapping data for a particular system.

Prod:

https://api.seic.com/v1/mappingUtility/{systemName}

Query Parameters

Name	Description	Data Type	Required
configExternalId		string

Header Parameters

Name	Description	Data Type	Required
Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".	string
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.	string

Path Parameters

Name	Description	Data Type	Required
systemName	The system for which the mapping utility will provide field mapping data. Valid value is crm.	string

HTTP Responses

Code

Description
200

OK- The request has succeeded and the response has been returned.
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

configExternalId

Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v1/mappingUtility/{systemName}

TLS*: https://mtls.api.seic.com/v1/mappingUtility/{systemName}

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 1

oAuthToken

POST

STEP 2

Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

Mapping Utility

GET

/{systemName}

Returns all the integration mapping data for a particular system.

Prod:

https://api.seic.com/v1/mappingUtility/{systemName}

Query Parameters

Name	Description	Data Type	Required
configExternalId		string

Header Parameters

Name	Description	Data Type	Required
Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".	string
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.	string

Path Parameters

Name	Description	Data Type	Required
systemName	The system for which the mapping utility will provide field mapping data. Valid value is crm.	string

HTTP Responses

Code

Description
200

OK- The request has succeeded and the response has been returned.
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

configExternalId

Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X GET \
  https://api.seic.com/v1/mappingUtility/crm \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \

REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH

REQUEST PAYLOAD MODEL

RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9

SAMPLE RESPONSE

{
  "data": {
    "salesforceDataSyncProcess": [
      {
        "sourceObjectName": "'https://api.seic.com/v1/investors/standard?active=true",
        "sourceObjectType": "API",
        "dbConnectionKey": "Default",
        "targetApiFileType": "JSON",
        "order": 1,
        "targetApiObject": "Investor_Account__c",
        "upsertKeyField": "Investor_Code__c",
        "processKey": "",
        "bulkApiColumns": [
          {
            "sourceColumnName": "externalId",
            "sourceParentColumnName": null,
            "isSourceColumnArray": false,
            "sourceColumnArrayFilterName": null,
            "sourceColumnArrayFilterValue": null,
            "destinationColumnName": "Investor_Code__c",
            "columnOrder": 1,
            "maxLength": 0
          },
          {
            "sourceColumnName": "fullName",
            "sourceParentColumnName": null,
            "isSourceColumnArray": false,
            "sourceColumnArrayFilterName": null,
            "sourceColumnArrayFilterValue": null,
            "destinationColumnName": "Investor_Name__c",
            "columnOrder": 2,
            "maxLength": 0
          },
          {
            "sourceColumnName": "primaryTaxId",
            "sourceParentColumnName": "pii",
            "isSourceColumnArray": false,
            "sourceColumnArrayFilterName": null,
            "sourceColumnArrayFilterValue": null,
            "destinationColumnName": "Investor_Tax_ID__c ",
            "columnOrder": 3,
            "maxLength": 0
          },
          {
            "sourceColumnName": "countryIsoCode",
            "sourceParentColumnName": "address",
            "isSourceColumnArray": true,
            "sourceColumnArrayFilterName": "type",
            "sourceColumnArrayFilterValue": "Legal",
            "destinationColumnName": "Investor_Legal_Country__c ",
            "columnOrder": 4,
            "maxLength": 0
          }
        ],
        "parameters": [],
        "enabled": true
      }
    ],
    "bulkRequestSize": 10000,
    "bulkApiVersion": "34.0"
  }
}

MODEL

Operations

Name	Description	Data Type (L)
salesforceDataSyncProcess	An array of configuration fields and data mapping necessary to support integration between two systems.	array
dbConnectionKey	Database key.	string
targetApiObject	The target API object that the data will be transmitted to via a POST call.	string
upsertKeyField	Upsert key.	string
processKey	Process key.	string
bulkAPIColumns	An array of source and destination field mapping pairs.	array
sourceColumnName	Source column name within the stored procedure or API call.	string
destinationColumnName	Destination column name within the stored procedure or API call.	string
columnOrder	Sort order of columns.	string
maxLength	Maximum allowable length.	string
parameterName	Name of the parameter for the stored procedure or API.	string
parameterValue	Value of the parameter for the stored procedure or API.	string
enabled	Identifies whether the mapping is enabled. true/false	string
bulkRequestSize	The size of the request.	string
bulkApiVersion	Version of the API.	string
sourceObjectName	Specifies the API URL or stored procedure name used as the source for the process mapping.	string
sourceObjectType	Identifies if the sourceObjectName (ie data source) is an ‘API’ or a ‘StoredProcedure’.	string
targetApiFileType	Identifies the format of the source output as either ‘JSON’ or ‘CSV’.	string
order	A single mapping configuration can be a collection of individual processes. The Order field identifies the sequence in which each process should be run with 1 being first. This is useful when there is a data dependency across the processes in a single mapping configuration.	string
sourceParentColumnName	When the field being mapped is contained in an object, the object name must be specified.	string
isSourceColumnArray	When the field being mapped is part of an array, isSourceColumnArray is ‘true’, otherwise it’s ‘false’. This tells the mapping utility how to interpret the response to build the output file.	TRUE
sourceColumnArrayFilterName	When the data being mapped is part of an array, the sourceColumnArrayFilterName is used to define filter criteria for mapping specific values to different destination fields. It is used in conjunction with sourceColumnArrayFiltervalue. Example: Investor Address is an array containing address types of Legal and Mailing address. sourceColumnArrayFilterName=type will allow mapping Legal address to one destination and Mailing address to another.	string
sourceColumnArrayFilterValue	When the data being mapped is part of an array, the sourceColumnArrayFilterValue is used to define filter criteria for mapping specific values to different destination fields. It is used in conjunction with sourceColumnArrayFilterName. Example: Investor Address is an array containing address types of Legal and Mailing address. sourceColumnArrayFilterValue=Mailing will allow mapping Mailing address to one destination and Legal address to another.	string
parameterType		string
parameters	The conditions that we need to supply in order to run a report	string

Mapping Utility

GET

/{systemName}

Returns all the integration mapping data for a particular system.

Prod:

https://api.seic.com/v1/mappingUtility/{systemName}

Query Parameters

Name	Description	Data Type	Required
configExternalId		string

Header Parameters

Name	Description	Data Type	Required
Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".	string
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.	string

Path Parameters

Name	Description	Data Type	Required
systemName	The system for which the mapping utility will provide field mapping data. Valid value is crm.	string

HTTP Responses

Code

Description
200

OK- The request has succeeded and the response has been returned.
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

configExternalId

Authorization	access_token value obtained from the Token endpoint.This is passed as "Bearer access_token".
AppKey	This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...