POST api/Activities
Create a new Activity
Request Information
URI Parameters
None.
Body Parameters
ActivityName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
SeriesId | globally unique identifier |
None. |
|
AccessorID | globally unique identifier |
None. |
|
IsCleared | boolean |
None. |
|
IsAlarmCreated | boolean |
None. |
|
IsAlarmed | boolean |
None. |
|
LeadMinutes | integer |
None. |
|
AlarmDue | string |
None. |
|
ExternalID | string |
None. |
|
Location | string |
None. |
|
IsTimeless | boolean |
None. |
|
IsPrivate | boolean |
None. |
|
PriorityId | integer |
None. |
|
ActivityPriorityName | string |
None. |
|
ActivityTypeId | integer |
None. |
|
ActivityTypeName | string |
None. |
|
Subject | string |
None. |
|
ScheduledBy | string |
None. |
|
ScheduledFor | string |
None. |
|
ScheduledForID | globally unique identifier |
None. |
|
ScheduledByID | globally unique identifier |
None. |
|
DeletedDates | Collection of date |
None. |
|
ClearedDates | Collection of date |
None. |
|
RecurSpec | ActivityRecurSpec |
None. |
|
EditDate | date |
None. |
|
CreateDate | date |
None. |
|
OccurTime | date |
None. |
|
OccurEndTime | date |
None. |
|
StartTime |
SQL Column Name: [START_DATE_TIME] |
date |
None. |
EndTime |
SQL Column Name: [END_DATE_TIME] |
date |
None. |
Details |
SQL Column Name: [DETAILS] |
string |
None. |
LinkedEntities | LinkedEntities |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "3e234d6f-a220-4f3b-93cf-8c356ec70ebd", "SeriesId": "9aa20158-072f-4bdc-9b36-bf19c3cab360", "AccessorID": "118558d4-d889-410b-bdc9-8db4f3ed485a", "IsCleared": true, "IsAlarmCreated": true, "IsAlarmed": true, "LeadMinutes": 7, "AlarmDue": "sample string 8", "ExternalID": "sample string 9", "Location": "sample string 10", "IsTimeless": true, "IsPrivate": true, "PriorityId": 13, "ActivityPriorityName": "sample string 14", "ActivityTypeId": 15, "ActivityTypeName": "sample string 16", "Subject": "sample string 17", "ScheduledBy": "sample string 18", "ScheduledFor": "sample string 19", "ScheduledForID": "484824a2-c240-4af7-b8be-f8da41234511", "ScheduledByID": "68aedc5f-cac8-4c27-93e1-fd1dc2ba5a0a", "DeletedDates": [ "2024-05-18T23:22:03Z", "2024-05-18T23:22:03Z" ], "ClearedDates": [ "2024-05-18T23:22:03Z", "2024-05-18T23:22:03Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2024-05-18T23:22:03Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-18T23:22:03Z", "CreateDate": "2024-05-18T23:22:03Z", "OccurTime": "2024-05-18T23:22:03Z", "OccurEndTime": "2024-05-18T23:22:03Z", "StartTime": "2024-05-18T23:22:03Z", "EndTime": "2024-05-18T23:22:03Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "3d619178-429d-4788-a183-6a385a9b1bb8", "5380abe2-a7b1-49f8-903f-b6ac8a0b79e8" ], "Companies": [ "661ea004-bf57-41ca-8fe4-c98cb88b2e19", "a495fa55-762f-428a-b35e-e0913fa1885b" ], "Groups": [ "ef29a92f-a965-4fc7-a80a-2c8bf7bfe2e9", "bc281763-d00a-4f2e-b26e-874fb4c3e7b1" ], "Opportunities": [ "7148df94-4b26-4762-9a84-e8bb39ba7219", "648d2b80-4407-4a95-ba91-2867aa2c3ad9" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"76f590e0-e345-4067-9679-fee37890f479"