Activity DTO v20

This is a common used object for different purposes, which has the special ability to have linked attachments (see Attachment).

  1. It is used for several cases like meetings, service task planning and appointments to store reminder, start and end date (see ActivityType.MEETING).
  2. After a meeting or engagement on customer side it is usually the case that there are some notes to be taken, so the next visitor has the full history about what is going on (see ActivityType.NOTE)
  3. In case of one had a call with a customer, there is the possibility to create an activity of an according type to make some notes that this phone call happened and what the content was (see ActivityType.CONVERSATION)

Activities can be linked to objects (see object parameter) of different types like:

  • Opportunities
  • ServiceCalls
  • SalesQuotation
  • SalesOrder
  • BusinessPartner
Field Name Type Required Constraint Reference Description
activityTemplate Identifier Optional ActivityTemplate : 8, 9, 10, 11
address Identifier Optional Address : 15, 16, 17, 18 Reference to the physical location of this activity (in normal case the address is related the corresponding business partner).
businessPartner Identifier Optional BusinessPartner : 16, 17, 18, 19, 20 Reference to the corresponding business partner, this field should be set regardless of the reference given by object parameter.
businessProcessStepAssignments List<BusinessProcessStepAssignmentEmbeddedDTO_V20> Optional Inlined list of business process list assignments.
changelog String Optional length >= 1 Stores the changes done
checkedOut Boolean Optional Used only in case of group checkouts.
code String Optional length >= 1 & length <= 255 System code of this object, normally this correlates to the erp id given by the source system.
contact Identifier Optional Contact : 12, 13, 14, 15, 16 Reference to the corresponding contact of the related business partner defined in the above 'businessPartner' property.
dueDateTime DateTime Optional Due date of this activity. endDateTime should be no later than this.
earliestStartDateTime DateTime Optional Earliest start of this activity. startDateTime should be no earlier than this.
endDateTime DateTime Optional Start date and time of this activity. This property is normally used for activities of type 'MEETING'.
equipment Identifier Optional Equipment : 14, 15, 16, 17, 18, 19, 20
executionStage String Optional length >= 1 & length <= 255

Allowed values are defined into Enumerations having enumType = ACTIVITY_EXECUTION_STAGE.
For learning about Enumerations, please check this.
Indicates the current execution stage of the activity. See Enumeration.name (type = 'ACTIVITY_EXECUTION_STAGE') for more information.
number String Optional length >= 1 & length <= 255
object ObjectRef Optional Referenced object of this activity. Standard referenced objects are opportunities, service calls, sales quotations, sales orders, business partners.
personal boolean Optional This flag indicates a personal activity. Regularly a personal activity does not have an object reference set.
predecessorActivities List<Identifier> Optional Activity : 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 A set of activity which are predecessors fot the given activity.
previousActivity Identifier Optional Activity : 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 Reference to the previous activity if available. If set, then the activity is interpreted as follow up activity.
project Identifier Optional Project : 8, 9, 10 Reference to a project.
projectOrdinal Integer Optional Defines the position inside a project.
projectPhase Identifier Optional ProjectPhase : 8, 9, 10 Reference to a phase of the project.
remarks String Optional length >= 1 Remarks or notes of this activity, can be used for any string based content which contains necessary information.
reminderDateTime DateTime Optional Date and time when a reminder should be triggered to notify the user about this upcoming event.
responsibles Set<Identifier> Optional Person : 15, 16, 17, 18, 19, 20 List of person objects (of type erpUsers) which are responsible for this activity. This list is considered by the permission system whenever read/write permission is set to OWN.
sourceActivity Identifier Optional Activity : 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 Indicates the origin activity when Activity copy is done.
startDateTime DateTime Optional Start date time of this activity. This property is normally used for activities of type 'MEETING'.
status String Optional length >= 1 & length <= 255

Allowed values are defined into Enumerations having enumType = ACTIVITY_STATUS.
For learning about Enumerations, please check this.
Indicates the current status of this activity. See Enumeration.name (type = 'ACTIVITY_STATUS') for more information.
subType Identifier Optional ActivitySubType : 11, 12, 13, 14 Reference to the sub type of this activity.
subject String Optional length >= 1 & length <= 255 Describes the activity subject. This is a short text summary or title of the object.
team Identifier Optional Team : 8, 9, 10 Reference to a team.
topic Identifier Optional ActivityTopic : 11, 12, 13, 14 Reference to the activities topic.
travelTimeFromInMinutes Integer Optional Travel time (in minutes) from the customer site.
travelTimeToInMinutes Integer Optional Travel time (in minutes) to the customer site.
type String Optional length >= 1 & length <= 255

Allowed values are defined into Enumerations having enumType = ACTIVITY_TYPE.
For learning about Enumerations, please check this.
Defines the type of the activity. See ActivityType for more information.