Activity
GET {{base_url}}/activity/:ActivityID
Use this endpoint to retrieve a single activity from the Activities hub. The response object fields return when you retrieve activity information by ActivityID. For additional detailed information for each field, call the activity metadata endpoint.
Response
| FieldName | Description |
|---|---|
| ActivityID | Unique identifier for the activity record |
| Type | Activity type. Valid values from CodeTable: CFGActivityType. |
| StartDate | Start date of the activity |
| EndDate | End date of the activity |
| HasNotes | Yindicates the record has notes. Nindicates that the record does not have notes. |
| Notes | Text with formatting of the notes for the record |
| CompletionInd | Nindicates the activity has not been completed. Yindicates that the activity is completed. |
| Subject | Description of the activity |
| RecurrType | The activity's recurrence type. For example: daily, monthly, weekly. |
| RecurrEndDate | User specified end date for the activity recurrence |
| CampaignID | Unique identifier for the campaign record |
| MktName | Name of the market segment the activity is targeting |
| ProjName | Project name |
| WBS1 | Project number for the project associated with the activity |
| EndDateSort | User specified date or indication that there is no end date and the type of activity for the system to sort the activity records by |
| Attendees | All attendees, both contacts and team members, who are scheduled to participate in the activity |
| Associations | Project, marketing campaign, and if available, user defined hub records to associate with the activity. |
| InstanceStartDate | Calendar date and time when the instance of the activity will start |
| StartDateObj | The start date is dependent on the milestone |
| EndDateObj | The end date is dependent on the milestone |
| RecurrStartDate | The data type for this field is dependent on whether or not the activity type is a milestone. If the activity type is a milestone, datetime will show. If the activity type is not a milestone, the date will show. For this reason, third parties can ignore the data type when consuming the API. |
| AllDayEventInd | Flag indicating whether the activity is an all day event. Yindicates that the activity is an all day event. When you select this option, the activity start time displays as 8:00 AM and the activity end time displays as 5:00 PM. However, you can change these times, if necessary. N(default) indicates that the activity is not an all day event. |
| RecurrenceInd | Yindicates the activity has recurrences. N(default) indicates the activity does not repeat. |
| RecurrDailyFreq | This field indicates the recurrence frequency when the RecurrType is daily. The number represents the daily frequency Every 3 days, for example. |
| RecurrDailyWeekDay | If the activity's recurrence is daily, this field is the flag indicating whether or not the activity repeats on weekdays only. Valid options: Yindicates weekdays only. Nindicates the activity repeats every day of the week. |
| RecurrWeeklyFreq | This field indicates the recurrence frequency when the RecurrType is weekly. The number specified represents the weekly frequency and then you must specify which day of the week. For example, Every 3 weeks on Wed. |
| RecurrWeeklySun | If the activity's recurrence is weekly, this flag indicates whether, or not the activity repeats on Sundays. Yindicates the activity repeats weekly on Sundays. Nindicates the activity does not repeat on Sundays. |
| RecurrWeeklyMon | If the activity's recurrence is weekly, this flag indicates whether, or not the activity repeats on Mondays. Yindicates the activity repeats weekly on Mondays. Nindicates the activity does not repeat on Mondays. |
| RecurrWeeklyTue | If the activity's recurrence is weekly, this flag indicates whether, or not the activity repeats on Tuesdays. Yindicates the activity repeats weekly on Tuesdays. Nindicates the activity does not repeat on Tuesdays. |
| RecurrWeeklyWed | If the activity's recurrence is weekly, this flag indicates whether, or not the activity repeats on Wednesdays. Yindicates the activity repeats weekly on Wednesdays. Nindicates the activity does not repeat on Wednesdays. |
| RecurrWeeklyThu | If the activity's recurrence is weekly, this flag indicates whether, or not the activity repeats on Thursdays. Yindicates the activity repeats weekly on Thursdays. Nindicates the activity does not repeat on Thursdays. |
| RecurrWeeklyFri | If the activity's recurrence is weekly, this flag indicates whether, or not the activity repeats on Fridays. Yindicates the activity repeats weekly on Fridays. Nindicates the activity does not repeat on Fridays. |
| RecurrWeeklySat | If the activity's recurrence is weekly, this flag indicates whether, or not the activity repeats on Saturdays. Yindicates the activity repeats weekly on Saturdays. Nindicates the activity does not repeat on Saturdays. |
| RecurrMonthlyFreq | If the RecurrType is monthly, this field indicates the recurrence frequency. For example, you can choose the specific numeric day and the for how many months 29th of every 5 Months. Or you can choose the recurrence by weekday. For example, Last Sunday of every 2 Months. |
| RecurrMonthlyOccur | The week of a given month when the recurring activity occurs. Valid options: 0 indicates the first week. 1 indicates the second week. 2 indicates the third week. 3 indicates the fourth week. 4 indicates the fifth week, if the month has five weeks. |
| RecurrMonthlyDay | If the RecurrType is monthly, this field is the day of the month when the activity repeats. |
| RecurrMonthlyOccurInd | Flag indicating the type of monthly recurrence pattern. Valid options: Yindicates a pattern of second Monday of every third month. Nindicates the tenth day of every month. |
| RecurrMonthlyOccurDay | The day of the week when the recurring activity repeats. Valid options: 1 Sunday, 2 Monday, 3 Tuesday, 4 Wednesday, 5 Thursday, 6 Friday, 7 Saturday. |
| RecurrMonthlyOccurFreq | The number of months in the monthly recurrence interval. Valid options: 1 indicates monthly. 2 indicates every other month. 3 indicates every third month. 4 indicates every fourth month and so on up to 12. |
| RecurrYearlyMonth | The month number for yearly recurrences |
| RecurrYearlyDay | If RecurrType is yearly, this field is the day of the month when the activity repeats. |
| RecurrEndType | Choose the type of recurrence completion. Default: N. Valid options: Nindicates Never, Aindicates the recurrence ends on a specified occurrence (MaxOccurrences), Yindicates the recurrence occurs until a specified date (RecurrEndDate). |
| Employee | Unique identifier for the employee record |
| RP | Indicates resource planning module. Nindicates that this object is not related to resource planning. Yindicates that this object is related to resource planning. |
| acType | Type of activity such as a phone call, meeting, WebEx, or an email |
| ShowTimeAs | How the scheduled activity appears on user's calendar. Valid options: Free, Busy, Out of office. |
| PrivateInd | Flag indicating whether only the marketing representative has access to the activity record. Details for a private activity can be viewed only by the attendees of the activity. Yindicates that the marketing representative has access to the activity record. Nindicates that the marketing representative does not have access to the activity record. |
| ReminderInd | Flag indicating whether there is a reminder for this activity. Yindicates that there is a reminder set for this activity. Nindicates that a reminder is not set for this activity. |
| ReminderUnit | The number that pairs with ReminderMinHrDay to define how and when the reminder is set |
| ReminderMinHrDay | What unit of time is specified for the reminder such as minutes, hours, or days and pairs with the reminder unit number |
| ReminderDate | Calculation of the date and time the reminder appears |
| isTask | Flag that indicates the activity is a task to be completed and not a calendar entry or meeting. Yindicates the activity is a task to be completed. If the activity is a meeting or calendar entry, N(default) indicates the activity is not a task to be completed. |
| isCalendar | Flag that indicates whether or not the activity appears on the calendar. Yindicates the activity appears on the calendar. If the activity is a task to be completed, N(default) indicates the activity does not appear on the calendar. |
| MaxOccurences | Upper limit and maximum number of occurrences for recurring activities |
| RecurrYearlyOccurInd | Flag indicating whether or not the activity is a yearly recurrence. Yindicates that the activity is a yearly recurrence. Nindicates the activity is not a yearly recurrence. |
| RecurrYearlyOccurDay | The day of the year for yearly recurrences to happen |
| RecurrYearlyOccurMonth | Month number for yearly recurrences to happen |
| RecurrYearlyOccur | Number of years for each yearly occurrence to happen |
| Location | Where the activity happens |
| WBS2 | Reference field for the project phase. Populated once WBS1 is populated. |
| WBS3 | Reference field for the project task. Populated once WBS1 is populated. |
| ClientName | Name of the client's organization from GET {{base_url}}/firm |
| ClientID | Unique identifier for the client record |
| CreateEmployee | Identifier for the employee who created the activity |
| TypeName | Name of the activity type |
| ContactID | Unique identifier for the contact record |
| LeadID | Unique identifier for the lead record |
| Priority | Priority ranking that indicates the relative importance of individual activities: High, Medium, or Low. Default: Medium. |
| PrimaryClient | Displays the name of the primary client such as a firm name |
| PriorityDesc | Not used |
| Duration | Calculated anticipated duration of the activity using the StartDate and EndDate. Not used. |
| Owner | Employee who is the designated owner |
| OwnerName | Name of the firm designated to the team as primary client with the role of owner |
| CreateUser | Name of the person who created the new record |
| CreateDate | Date and timestamp when the new record was created |
| ModUser | Name of the person who modified an existing record of this type |
| ModDate | Date and timestamp when the existing record of this type was modifiedTaskCompletionDate. If the activity is a task, this field is the date when the task was completed |
| RecurrID | Unique identifier for the recurrence. Not used. |
| OutlookType | This field has an activity's display category. The category determines where the activity displays in Connect for Microsoft Outlook if the activity is synchronized with Connect for Microsoft Outlook. Not Used. |
| Vendor | Not used |
| VendorName | Not used |
| ContactIDForVendor | Internal identifier of the contact associated with the activity vendor |
| ContactNameForVendor | Name of the contact associated with the activity vendor |
| ContactPhoneForVendor | Phone number for the contact associated with the activity vendor |
| EndDateFilte | User specified date or indication that there is no end date and the type of activity for the system to filter the activity records by |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: OK
[{"ActivityID":"77917AE2EA5D4690AB6F76DA3B66EBF4","Type":"EMail","StartDate":"2017-05-02T13:00:00.000","EndDate":"2017-05-02T13:30:00.000","HasNotes":"Y","Notes":"this is\u0026nbsp;a test","CompletionInd":"N","Subject":"test1","RecurrType":"","RecurrEndDate":"","CampaignID":"","MktName":"","OpportunityID":"","OppName":"","ProjName":"","WBS1":"","EndDateSort":"2017.05.02 EMail","Attendees":"Alexander Carl, PE Billy Boy Charles, Jr.","Associations":"","InstanceStartDate":"2017-05-02T13:00:00.000","StartDateObj":"2017-05-02T13:00:00.000","EndDateObj":"2017-05-02T13:30:00.000","RecurrStartDate":"","AllDayEventInd":"N","RecurrenceInd":"N","RecurrDailyFreq":1,"RecurrDailyWeekDay":"N","RecurrWeeklyFreq":1,"RecurrWeeklySun":"N","RecurrWeeklyMon":"N","RecurrWeeklyTue":"N","RecurrWeeklyWed":"N","RecurrWeeklyThu":"N","RecurrWeeklyFri":"N","RecurrWeeklySat":"N","RecurrMonthlyFreq":1,"RecurrMonthlyOccur":0,"RecurrMonthlyDay":0,"RecurrMonthlyOccurInd":"N","RecurrMonthlyOccurDay":0,"RecurrMonthlyOccurFreq":1,"RecurrYearlyMonth":0,"RecurrYearlyDay":0,"RecurrEndType":"N","Employee":"00001","RP":"N","acType":"EMail","ShowTimeAs":"Busy","PrivateInd":"N","ReminderInd":"N","ReminderUnit":15,"ReminderMinHrDay":"Minutes","ReminderDate":"2017-05-02T12:45:00.000","isTask":"Y","isCalendar":"N","MaxOccurences":0,"RecurrYearlyOccurInd":"N","RecurrYearlyOccurDay":0,"RecurrYearlyOccurMonth":0,"RecurrYearlyOccur":0,"Location":"","WBS2":"","WBS3":"","ClientName":"","ClientID":"","CreateEmployee":"00001","TypeName":"EMail","ContactID":"ADMIN1017949993769","LeadID":"","Priority":"Medium","OppEstStartDate":"","OppEstCompletionDate":"","custTestQuery":"","custTEst1":"","custUserdefinedfieldjb":"","PrimaryClient":"","PriorityDesc":"Medium","Duration":0,"Owner":"00001","OwnerName":"Billy Boy Charles, Jr.","ContactName":"Alexander Carl, PE","CreateUser":"Billy Boy Charles, Jr.","CreateDate":"2017-05-01T19:39:38.937","ModUser":"Billy Boy Charles, Jr.","ModDate":"2017-05-01T19:39:38.937","TaskCompletionDate":"","RecurrID":"","OutlookType":"Generic","Vendor":"","VendorName":"","ContactIDForVendor":"","ContactNameForVendor":"","ContactPhoneForVendor":"","EndDateFilter":"05/02/2017 EMail","CLActivityRow":[],"ActivityEmployeeContactsRow":[{"ActivityID":"77917AE2EA5D4690AB6F76DA3B66EBF4","RecordType":"contact","FirstLast":"Alexander Carl, PE","ContactID":"ADMIN1017949993769","Employee":"","PrimaryInd":"Y","ContactHasPhoto":"N","Email":"","ClientID":"","Phone":"","CellPhone":"","Owner":"","LastFirst":"Carl, Alexander","Title":"President","RecordID":"ADMIN1017949993769"},{"ActivityID":"77917AE2EA5D4690AB6F76DA3B66EBF4","RecordType":"employee","FirstLast":"Billy Boy Charles, Jr.","ContactID":"","Employee":"00001","PrimaryInd":"","ContactHasPhoto":"Y","Email":"julibertram@deltek.com","ClientID":"","Phone":"456","CellPhone":"","Owner":"Y","LastFirst":"Charles, Billy Boy","Title":"Principal","RecordID":"00001"}],"UDIC_OuterSpaceActivityRow":[]}]