Link a Case to Another Case
If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can create cases in MYOB Acumatica and link them to another case defined in MYOB Acumatica. For details about the relations between cases, see Case Management: General Information.
Testing of the Request
Before you test the code below, you need to do the
following to configure your client application and the MYOB Acumatica
instance to be used:
- Deploy a new MYOB Acumatica instance with the U100 dataset. For details on deploying an instance, see To Deploy an MYOB Acumatica Instance.
- To sign in to the instance in the client application, use the tenant name (which you specified when you created the instance) and the HEADOFFICE branch.
- If you use Postman as the client application for testing, in the IntegrationDevelopmentGuide.postman_collection.json collection (which is located in the IntegrationDevelopment\Help folder of the Help-and-Training-Examples repository on GitHub), make sure the collection variables have the proper values.
Request
You can use the following request example to create a case and link it to another case through the contract-based REST API.
Tip: In the request example below,
<MYOB Acumatica instance URL>
is the URL of the MYOB Acumatica
instance (such as https://my.acumatica.com/MyInstance). You can omit the instance
name in the URL (that is, you can use https://my.acumatica.com) if the instance
is installed in the root of the website.PUT / HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/23.200.001/Case?$expand=RelatedCases
Accept: application/json
Content-Type: application/json
{
"ClassID": {
"value": "SERVCONS"
},
"BusinessAccount": {
"value": "GOODFOOD"
},
"Subject": {
"value": "Billing plan"
},
"RelatedCases": [
{
"CaseID": {
"value": "000004"
}
}
]
}
Usage Notes
To create a case and establish its relation with another case, you need to specify
the case ID of the related case by using the CaseID field of the
RelatedCases detail entity of the Case
entity.
Note: The ParentCaseID field of the
RelatedCases detail entity of the Case
entity is never returned by the system and cannot be used for the assignment of
values.