REST API - unlinkx

The table summarizes the REST API - unlinkx.

Request

Format 
PUT <baseurl>/ref/<caseReference>/unlinkx/<roleName>
Path parameters
  • caseReference: The case reference of the case data you want to disassociate with other case data. For example, BDS-2-com.example.gddemo.Customer-1-1. You must only specify one. You can obtain the case reference by using findAllCases.
  • roleName: The name of the association. For example, claim.
Body Consists of a list of case references that you want to disassociate the source case reference from. 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 an UnlinkCaseResponse element.
XML Returns the contents of an UnlinkCaseResponse element (from the BusinessDataServices schema).

Example

Request 
PUT <baseurl>/globaldata/ref/BDS-2-com.example.gddemo.Customer-29-1/unlinkx/cars
Request body 
<xml-fragment>
<caseReference xmlns="">BDS-2-com.example.gddemo.Car-19-7</caseReference>
<caseReference xmlns="">BDS-2-com.example.gddemo.Car-21-7</caseReference>
</xml-fragment>
Response 
{
       "xml-fragment":
       {
           "caseReference": "BDS-2-com.example.gddemo.Customer-29-2",
           "targetCaseReference":
           [
               "BDS-2-com.example.gddemo.Car-19-8",
               "BDS-2-com.example.gddemo.Car-21-8"
           ]
       }
}