Create an Activity that Is Linked to a Case

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can establish the relationship of the Activity, Event, Task, and Email objects with cases in MYOB Acumatica. You can also establish this relationship by using the Create Activity, Create Event, Create Task, or Create Email button on Activities tab of the Cases (CR306000) form. For details about the management of 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:
  1. Deploy a new MYOB Acumatica instance with the U100 dataset. For details on deploying an instance, see To Deploy an MYOB Acumatica Instance.
  2. 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.
  3. 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 an activity that is linked to a case through the contract-based REST API. In the RelatedEntityNoteID field, you use the ID value of the case for linking. This ID value is present, for example, in the response body when you create a case, as described in Create a Case.

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/Activity
Accept: application/json
Content-Type: application/json

{
    "Summary": {"value": "Automated Test"},
    "Type": {"value": "M"},
    "RelatedEntityNoteID": {"value": "{{NoteID}}"},
    "RelatedEntityType": {"value": "PX.Objects.CR.CRCase"},
    "ActivityDetails":{"value": "Automated Test"}
}

Usage Notes

In the Default/20.200.001, Default/22.200.001, and Default/23.200.001 endpoints, you use the following fields of the Activity entity:
  • RelatedEntityNoteID: The NoteID value of the object with which the relationship is established.
  • RelatedEntityType: The full name of the type of the object with which the relationship is established (namely, PX.Objects.CR.CRCase).
  • RelatedEntityDescription: The description of the related object. This field is read-only.