FINS Thought Machine Customers System API - Implementation Template
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
| Module | Description |
|---|---|
| create-customer-address-request | Customer Address Create Mapping for Thought Machine System |
| create-customers-individual-request | Customer Create Mapping for Thought Machine System |
| create-customers-organization-request | Customer Create Mapping for Thought Machine System |
| get-customer-lookup-response | Retrieve Customer from Thought Machine response mapping |
| get-customer-response | Retrieve Customer from Thought Machine response mapping |
| ping-check-dependency-sys-api-response | |
| update-customer-addition-info | Update Customer Additional Information request for Thought Machine response mapping |
| update-customer-address | Update Customer Address in Thought Machine response mapping |
| update-customer-request | Customer Update Mapping for Thought Machine System |
| get-customer-audit-info-response | Customer Action Log response mapping |
create-customer-address-request
Customer Address Create Mapping for Thought Machine System
Source:
./src/main/resources/dwl/create-customer-address-request.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by Thought Machine - Create Customer Address
| JSON used by the Thought Machine | CIM | Description |
|---|---|---|
| customer_address.street | party.contactPoints.ContactPointAddress.addressLine1 | The address detail Customer. |
| customer_address.city | party.contactPoints.ContactPointAddress.cityName | The city of the Customer. |
| customer_address.postal_area | party.contactPoints.ContactPointAddress.postalCodeText | The city of the Customer. |
| customer_address.governing_district | party.contactPoints.ContactPointAddress.stateProvinceName | The state of the Customer. |
| customer_address.country | party.contactPoints.ContactPointAddress.country | The country of the Customer. |
| customer_address.address_type | CUSTOMER_ADDRESS_TYPE_UNKNOWN | The Address Type of the Customer. |
| customer_address.customer_id | customerId | The customerId of the Customer. |
create-customers-individual-request
Customer Create Mapping for Thought Machine System
Source:
./src/main/resources/dwl/create-customers-individual-request.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by Thought Machine - Create Customer
| JSON used by the Thought Machine | CIM | Description |
|---|---|---|
| customer.status | customerStatus | The status of the customer |
| customer_details.title | party.salutation | The salutation of the Customer. |
| customer_details.first_name | party.firstName | The Firstname of the Customer. |
| customer_details.last_name | party.lastName | The lastname of the Customer. |
| customer_details.dob | party.birthDate | The date of birth of the Customer. |
| customer_details.email_address | party.contactPoints.ContactPointEmail.emailAddress | The email of the Customer. |
| customer_details.mobile_phone_number | party.contactPoints.ContactPointPhone.telephoneNumber | The Phone Number of the Customer. |
| customer_details.external_customer_id | externalIds.externalId | The externalId of the Customer. |
| additional_details.createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| additional_details.createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| additional_details.updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| additional_details.updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
| additional_details.isDeleted | auditInfo.createdBy | Customer Delete Information Stored in Thought Machine |
| additional_details.customerNumber | customerNumber | The Customer Number to be stored in Thought Machine |
| additional_details.partyType | Individual | partyType to be stored in Thought Machine |
create-customers-organization-request
Customer Create Mapping for Thought Machine System
Source:
./src/main/resources/dwl/create-customers-organization-request.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by Thought Machine - Create Customer
| JSON used by the Thought Machine | CIM | Description |
|---|---|---|
| customer.status | customerStatus | The status of the customer |
| customer_details.title | party.salutation | The salutation of the Customer. |
| customer_details.first_name | party.firstName | The Firstname of the Customer. |
| customer_details.last_name | party.lastName | The lastname of the Customer. |
| customer_details.dob | party.birthDate | The date of birth of the Customer. |
| customer_details.email_address | party.contactPoints.ContactPointEmail.emailAddress | The email of the Customer. |
| customer_details.mobile_phone_number | party.contactPoints.ContactPointPhone.telephoneNumber | The Phone Number of the Customer. |
| customer_details.external_customer_id | externalIds.externalId | The externalId of the Customer. |
| additional_details.createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| additional_details.createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| additional_details.updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| additional_details.updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
| additional_details.isDeleted | auditInfo.createdBy | Customer Delete Information Stored in Thought Machine |
| additional_details.customerNumber | customerNumber | The Customer Number to be stored in Thought Machine |
| additional_details.partyType | Organization | partyType to be stored in Thought Machine |
get-customer-lookup-response
Retrieve Customer from Thought Machine response mapping
Source:
./src/main/resources/dwl/get-customer-lookup-response.dwl
Variables
var s
Maps CIM Customer to JSON which is used by Thought Machine - Get Customer
Mapping Tables
Maps CIM Customer to JSON which is used by Thought Machine - Get Customer
| CIM | Thought Machine | Description |
|---|---|---|
| id | id | The id of the customer in Thought Machine System |
| customerNumber | additional_details.customerNumber | The Customer Number in Thought Machine System |
| customerStatus | customer.status | The status of the customer in Thought Machine system |
| party.id | null | Set as null. |
| party.salutation | customer_details.title | The Salutation of the Customer. |
| party.personName | FirstName ++ LastName | Fullname of the Customer (concatenate FistName + LastName). |
| party.firstName | customer_details.firstName | The Firstname of the Customer. |
| party.lastName | customer_details.lastName | The Lastname of the Customer. |
| party.birthDate | customer_details.dob | The Customer birth date. |
| party.partyType | additional_details.partyType | The party type of the customer. |
| party.contactPoints | customer_details.identifiers | The Contact Points of the customer. |
| externalIds | customer_details.external_customer_id | The externalIds of the customer that are stored in Thought Machine System |
| auditInfo.createdBy | additional_details.createdDate | Identifies the system or user which created the entity |
| auditInfo.createdDate | CREATED_DATETimestamp of when the entity was created - default as current timestamp | |
| auditInfo.updatedBy | additional_details.createdDate | Identifies the system or user which last updated the entity |
| auditInfo.updatedDate | additional_details.createdDate | Timestamp of when the entity was last updated |
| auditInfo.isDeleted | additional_details.createdDate | Indicates whether or not the entity has been soft-deleted - default as false |
get-customer-response
Retrieve Customer from Thought Machine response mapping
Source:
./src/main/resources/dwl/get-customer-response.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by Thought Machine - Get Customer
| CIM | Thought Machine | Description |
|---|---|---|
| id | id | The id of the customer in Thought Machine System |
| customerNumber | additional_details.customerNumber | The Customer Number in Thought Machine System |
| customerStatus | customer.status | The status of the customer in Thought Machine system |
| party.id | null | Set as null. |
| party.salutation | customer_details.title | The Salutation of the Customer. |
| party.personName | FirstName ++ LastName | Fullname of the Customer (concatenate FistName + LastName). |
| party.firstName | customer_details.firstName | The Firstname of the Customer. |
| party.lastName | customer_details.lastName | The Lastname of the Customer. |
| party.birthDate | customer_details.dob | The Customer birth date. |
| party.partyType | additional_details.partyType | The party type of the customer. |
| party.contactPoints | customer_details.identifiers | The Contact Points of the customer. |
| externalIds | customer_details.external_customer_id | The externalIds of the customer that are stored in Thought Machine System |
| auditInfo.createdBy | additional_details.createdDate | Identifies the system or user which created the entity |
| auditInfo.createdDate | CREATED_DATETimestamp of when the entity was created - default as current timestamp | |
| auditInfo.updatedBy | additional_details.createdDate | Identifies the system or user which last updated the entity |
| auditInfo.updatedDate | additional_details.createdDate | Timestamp of when the entity was last updated |
| auditInfo.isDeleted | additional_details.createdDate | Indicates whether or not the entity has been soft-deleted - default as false |
ping-check-dependency-sys-api-response
Source:
./src/main/resources/dwl/ping-check-dependency-sys-api-response.dwl
update-customer-addition-info
Update Customer Additional Information request for Thought Machine response mapping
Source:
./src/main/resources/dwl/update-customer-addition-info.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by Thought Machine - Create Customer Address
| JSON used by the Thought Machine | CIM | Description |
|---|---|---|
| additional_details.createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| additional_details.createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| additional_details.updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| additional_details.updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
| additional_details.isDeleted | auditInfo.createdBy | Customer Delete Information Stored in Thought Machine |
| additional_details.customerNumber | customerNumber | The Customer Number to be stored in Thought Machine |
| additional_details.partyType | Individual | partyType to be stored in Thought Machine |
update-customer-address
Update Customer Address in Thought Machine response mapping
Source:
./src/main/resources/dwl/update-customer-address.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by Thought Machine - Update Customer Address
| JSON used by the Thought Machine | CIM | Description |
|---|---|---|
| customer_address.street | party.contactPoints.ContactPointAddress.addressLine1 | The address detail Customer. |
| customer_address.city | party.contactPoints.ContactPointAddress.cityName | The city of the Customer. |
| customer_address.postal_area | party.contactPoints.ContactPointAddress.postalCodeText | The city of the Customer. |
| customer_address.governing_district | party.contactPoints.ContactPointAddress.stateProvinceName | The state of the Customer. |
| customer_address.country | party.contactPoints.ContactPointAddress.country | The country of the Customer. |
| customer_address.address_type | CUSTOMER_ADDRESS_TYPE_UNKNOWN | The Address Type of the Customer. |
| customer_address.customer_id | customerId | The customerId of the Customer. |
update-customer-request
Customer Update Mapping for Thought Machine System
Source:
./src/main/resources/dwl/update-customer-request.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by Thought Machine - Update Customer
| JSON used by the Thought Machine | CIM | Description |
|---|---|---|
| customer.status | customerStatus | The status of the customer |
| customer_details.title | party.salutation | The salutation of the Customer. |
| customer_details.first_name | party.firstName | The Firstname of the Customer. |
| customer_details.last_name | party.lastName | The lastname of the Customer. |
| customer_details.dob | party.birthDate | The date of birth of the Customer. |
| customer_details.email_address | party.contactPoints.ContactPointEmail.emailAddress | The email of the Customer. |
| customer_details.mobile_phone_number | party.contactPoints.ContactPointPhone.telephoneNumber | The Phone Number of the Customer. |
| customer_details.external_customer_id | externalIds.externalId | The externalId of the Customer. |
| additional_details.createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| additional_details.createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| additional_details.updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| additional_details.updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
| additional_details.isDeleted | auditInfo.createdBy | Customer Delete Information Stored in Thought Machine |
| additional_details.customerNumber | customerNumber | The Customer Number to be stored in Thought Machine |
| additional_details.partyType | Individual | partyType to be stored in Thought Machine |
get-customer-audit-info-response
Customer Action Log response mapping
Source:
./src/main/resources/dwl/get-customer-audit-info-response.dwl
Mapping Tables
The action-logs endpoint of the Audit API is used to retrieve the Audit information of an Account in Thought Machine
| action-logs Response | CIM | Description |
|---|---|---|
| action_logs.request_initiator_id | createdBy | The ID of the User who created the Customer. |
| action_logs.create_timestamp | createdDate | Timestamp of when the Customer was last created. |
| action_logs.request_initiator_id | updatedBy | The ID of the User who last update the Customer. |
| action_logs.create_timestamp | updatedDate | Timestamp of when the Customer was last updated. |