Business Entity Services Guide

10.4 HotFix 2

Back Next

Step 2. Create a Record

Use the Create Record REST API to create a record. The name of the business entity and the name of the source system are required parameters. Send data for the record in the request body.

The Create Record URL has the following format:

http://<host>:<port>/<context>/<database ID>/<business entity>?systemName=<name of the source system>

The

systemName

parameter is a required parameter and specifies the name of the source system.

The Person business entity has the Person root node, and the second level address, gender, and phone nodes.

The following sample request creates a Person record:

POST http://localhost:8080/cmx/cs/localhost-hub101-ds_ui1/Person?systemName=Admin
{
    "firstName": "Boris",
    "lastName": "Isaac",
    "genderCd": {
        "genderCode": "M"
    },
    "Address": {
        "item": [
            {
                "Address": {
                    "addressLine1": "B-203, 101 Avenue, New York",
                    "stateCd": {
                        "stateAbbreviation": "NY"
                    },
                    "countryCode": {
                        "countryCode": "US"
                    }
                }
            }
        ]
    },
    "Telephone": {
        "item": [
            {
                "phoneNum": "1234567",
                "phoneTypeCd": {
                    "phoneType": "HOM"
                }
            },
            {
                "phoneNum": "7654321",
                "phoneTypeCd": {
                    "phoneType": "MOB"
                }
            }
        ]
    }
}

The request body specifies the following details of the Person record:

First name.

Last name.

Gender.

Address with the state code and the country code.

Phone numbers along with the phone type, such as home phone and mobile phone.

Appendix A: Using REST APIs to Add Records

Create Record Response

Download Guide

Watch

Comments

Communities