Business Entity Services Guide

10.5

Back Next

Sample API Requests

The following sample request creates a record in the Person business entity. The request adds a comment and attachment to the workflow task that the API triggers.

POST http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?systemName=Admin&taskComment=Read my comment&taskAttachments=TEMP_SVR1.29OT8,TEMP_SVR1.29OT9
Content-Type: application/json

{
   "firstName":"John",
   "lastName":"Smith",
   "Phone":{
      "item":[
         {
            "phoneNumber":"111-11-11"
         }
      ]
   }
}

When you use a POST REST API request to create a new record, you can set the

sourceKey

attribute in the POST request body. The

sourceKey

attribute is used as the

pkey_src_object

value in the XREF table. For example, yu might send the following POST request to create a new Party record and the Party XREF record with the source system SFA and the

pkey_src_object

123:

 POST http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person?systemName=SFA

{
    "firstName": "John",
    "middleName": "jr",
    "lastName": "Smith",
    "genderCd": {
        "genderCode": "M"
    },
    "key": {
        "sourceKey": "123"
    }
}

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Sample API Requests

Sample API Requests