Activities: Required Attributes and Path Parameters
This section lists the required attributes and path parameters for the request payloads of the Activities resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
|
Parent Level |
Activity |
|
Child Resources |
Activity Assignee |
|
Activity Contact |
|
|
Activity Objective |
|
|
Note |
|
|
Attachment |
The following table lists the attributes required for the POST method for Activities resource.
| Resource | Attribute | Attribute Description |
|---|---|---|
|
Activity |
Subject |
The unique subject, name, or title of the activity. |
|
ActivityFunctionCode |
The activity that compares tasks with appointments. The list of values for activity function codes is available in the ActivityFunctionCodeListVA. |
|
|
ActivityStartDate |
The starting date and time of an appointment or a task. The default value for an appointment is null. The default value for a task is the date and time of when a task is created. Note: Activity Start Date is required if the ActivityFunctionCode is APPOINTMENT or CALLREPORT. |
|
|
ActivityEndDate |
The date and time of when an appointment ends. The time when a task is completed. Note: Activity End Date is required if the ActivityFunctionCode is APPOINTMENT or CALLREPORT. |
The following table lists the attributes required for the POST method for Activities child resources.
| Resource | Attribute | Attribute Description |
|---|---|---|
|
Activity > Activity AssigneeId |
AssigneeId |
The unique identifier of the assignee associated with the activity. |
|
Activity > Activity Contacts |
ContactId |
The unique identifier of the contact associated with the activity. |
|
Activity > Activity Objectives |
ObjectiveCode |
The objective of the activity. The list of values for objective codes is available in the ObjectiveLookup. |
|
ObjectiveFreefmtText |
The text area to describe the objective of the activity. |
|
|
Activity > Note |
NoteTxt |
The column to store the note text. |
|
NoteTypeCode |
The note type code for categorization of the note. The list of values for the note type code is available in the NoteSourceTypeVA. |
|
|
VisibilityCode |
The visibility level of the note. The list of values for the visbility code is available in the NoteVisibilityLookupVA. |
|
|
Activity > Attachment |
CategoryName |
The category of the attachment. |
|
DataTypeCode |
A value that indicates the data type. |
|
|
FileContents |
The contents of the attachment. |
|
|
Title |
The title of the attachment. |
|
|
FileName |
The file name of the attachment. |
Note:
In the Activity Objectives child resource, you can use either OjectiveCode or ObjectiveFreefmtText.The following table lists the path parameters required for the PATCH method for Activities resource.
| Resource | Path | Path Parameters |
|---|---|---|
|
Activity |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId} |
ActivityId |
The following table lists the path parameters required for the PATCH method for Activities child resources.
| Resource | Path | Path Parameters |
|---|---|---|
|
Activity > Activity AssigneeId |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/ActivityAssignee/{ActivityAssigneeUniqID} |
ActivityId ActivityAssigneeUniqID |
|
Activity > Activity Contacts |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/ActivityContact/{ActivityContactUniqID} |
ActivityId ActivityContactUniqID |
|
Activity > Activity Objectives |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/ActivityObjectives/{ObjectiveId} |
ActivityId ObjectiveId |
|
Activity > Note |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/Note/{NoteId} |
ActivityId NoteId |
|
Activity > Attachment |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/Attachments/{AttachmentsUniqID} |
ActivityId AttachmentsUniqID |