REST API - linkx

The table summarizes the REST API - linkx.

Request

Format 
PUT <baseurl>/globaldata/ref/<caseReference>/linkx/<roleName>
Path parameters
  • caseReference: The case reference of the case data you want to associate with other case data. For example, BDS-2-com.example.gddemo.Customer-1-1. You must only specify one.
  • roleName: The name of the association. For example, claim.
Body caseReferenceArray. the parameters in the LinkCaseRequest element (from the BusinessDataServices schema). You can obtain case references using findAllCases . For example, BDS-2-com.example.gddemo.Customer-1-0.

Response

JSON Returns a JSON representation of the contents of a LinkCaseResponse element.
XML Returns the contents of an LinkCaseResponse element (from the BusinessDataServices schema).

Example

Request 
PUT <baseurl>/globaldata/ref/BDS-2-com.example.gddemo.Customer-13-0/linkx/cars
Body 
<xml-fragment>
<caseReference xmlns="">BDS-2-com.example.gddemo.Car-1-0</caseReference>
<caseReference xmlns="">BDS-2-com.example.gddemo.Car-11-0</caseReference>
</xml-fragment>
Response 
{
       "xml-fragment":
       {
           "caseReference": "BDS-2-com.example.gddemo.Customer-13-1",
           "targetCaseReference":
           [
               "BDS-2-com.example.gddemo.Car-1-1",
               "BDS-2-com.example.gddemo.Car-11-1"
           ]
       }
}