Get an activity assignee
get
/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee/{ActivityAssigneeUniqID}
Request
Path Parameters
-
ActivityAssigneeUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ActivityId and AssigneeId ---for the Activity Assignees resource and used to uniquely identify an instance of Activity Assignees. The client should not generate the hash key value. Instead, the client should query on the Activity Assignees collection resource with a filter on the primary key values in order to navigate to a specific instance of Activity Assignees.
For example: ActivityAssignee?q=ActivityId=<value1>;AssigneeId=<value2> -
ActivityNumber(required): string
The unique number of the activity. The number can also be generated from an external source.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : activities-ActivityAssignee-item-response
Type:
Show Source
object-
ActivityAssigneeId: integer
(int64)
The unique identifier for the activity assignee.
-
ActivityAssigneeKey: string
Read Only:
trueMaximum Length:80Activity assignee composite key -
ActivityFunctionCode: string
Maximum Length:
30The code indicating the function of the activity. -
ActivityId: integer
(int64)
Title:
Activity IDThe unique identifier of the parent activity. -
ActyActivityNumber: string
Title:
Activity NumberMaximum Length:64The unique number of the activity. The number can also be generated from an external source. -
AssigneeId: integer
(int64)
Title:
Assignee IDThe unique identifier of the assignee associated with the activity. -
AssigneeName: string
Title:
NameThe name of the assignee. -
AssigneePartyNumber: string
The alternate key identifier of the activity resource.
-
AtkMessageId: integer
(int64)
The identifier for the ATK popup notification created.
-
AttendeeFlag: boolean
Title:
AttendanceMaximum Length:1Default Value:trueIndicates if the resource attended the activity. If True, the resource attended. -
ConflictId: integer
(int64)
Default Value:
0This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete. -
CorpCurrencyCode: string
Maximum Length:
15The corporate currency code associated with the activity assignee. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the activity assignee. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time of when the activity assignee was created. -
CurcyConvRateType: string
Maximum Length:
30The currency conversion rate type associated with the activity assignee. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Maximum Length:
15The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DismissFlag: boolean
Title:
DismissedMaximum Length:1Default Value:falseIndicates if the activity has been dismissed. The default value is false. -
JobName: string
Title:
TitleThe job name for the activity assignee. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when data related to an activity assignee was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The unique identifier of the user who last updated the activity assignee. -
LastUpdateLogin: string
Title:
Last Updated LoginRead Only:trueMaximum Length:32The login details of the user who last updated the activity assignee. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Phone: string
Title:
PhoneThe phone number of the contact. -
PrimaryAssigneeFlag: string
Title:
OwnerThe primary assignee for an Activity. -
PrimaryEmail: string
Title:
EmailThe e-mail address of the activity assignee contact. -
PrimaryFormattedAddress: string
The primary formatted address information of an activity assignee.
-
RecurSeriesId: integer
(int64)
The unique identifier for the series that links instances of a series together.
-
ReminderDatetime: string
(date-time)
Title:
Reminder TimeThe date and time to send the appointment reminder. -
ReminderPeriod: integer
(int32)
Title:
ReminderThe time period before the start date and time of an activity when a reminder should be sent to the resources on an activity. -
ResourceName: string
Title:
NameRead Only:trueThe name of activity resource. -
ResourceNumber: string
Title:
Resource NumberRead Only:trueMaximum Length:30Resource Number of the resource associated with the activity. -
ResponseCode: string
Title:
ResponseMaximum Length:30Default Value:NOT_RESPONDEDThe code indicating the response of a resource on an appointment. -
SenderJobId: integer
(int64)
Title:
Sender Job IDThe unique identifier of the sender job. -
ShowTimeAsCode: string
Title:
Show Time AsMaximum Length:30The choice of display of time on your calendar for an appointment, for example: free, busy, tentative. -
smartActions: array
Smart Actions
Title:
Smart ActionsThe smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SortDate: string
(date-time)
The date used to sort activities.
-
StatusCode: string
Maximum Length:
30The status of the activity. -
TaskReminderPeriod: integer
(int32)
Title:
Due Date ReminderAllows the user to select the reminder period for a task due date. For example, 1 day before the task due date. -
UpgSourceObjectId: integer
(int64)
Read Only:
trueThe primary key value of the record in the source table that is upgraded to Rel9 Activity record. -
UpgSourceObjectType: string
Read Only:
trueMaximum Length:30The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record. -
UserGuid: string
The unique identifier of user (Not for public usage).
-
UserGuid1: string
Read Only:
trueThe unique identifier of the user (Not for public usage). -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update DateThe date and time when the record was last updated by a user in the disconnect mode. -
UserName: string
The name of the user.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThe smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : activities-ActivityAssignee-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content TypeMaximum Length:50The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action NameMaximum Length:256The display name of the smart action. -
Entity: string
Title:
Parent EntityMaximum Length:150The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST EndpointMaximum Length:1024The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512The client applications that the smart action is associated with. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action IDThe unique identifier of the smart action definition. -
UserActionName: string
Title:
Action NameMaximum Length:256The unique identifier of the smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityThe number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsThe payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
UserActionURLBinding: array
Smart Action REST Path Parameter Definitions
Title:
Smart Action REST Path Parameter DefinitionsThe path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsThe payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type:
arrayTitle:
Smart Action REST Path Parameter DefinitionsThe path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : activities-ActivityAssignee-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseIndicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : activities-ActivityAssignee-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseIndicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- ReminderListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_REMINDER
The list of values indicating how soon before the appointment to send a reminder.
The following properties are defined on the LOV link relation:- Source Attribute: ReminderPeriod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ResponseCodeListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RESPONSE_CD
The list of values to decide whether a reminder is needed.
The following properties are defined on the LOV link relation:- Source Attribute: ResponseCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ShowTimeAsCodeListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_SHOWTIMEAS_CD
The list of values indicating the display of time on your calender for an appointment, such as free, busy, tentative.
The following properties are defined on the LOV link relation:- Source Attribute: ShowTimeAsCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TaskReminderListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZMM_TASK_REMINDER
The list of values indicating how soon before the task to send a reminder.
The following properties are defined on the LOV link relation:- Source Attribute: TaskReminderPeriod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoAttendeeFlagLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating if the resource attended the activity. If True, the resource attended.
The following properties are defined on the LOV link relation:- Source Attribute: AttendeeFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating if the activity has been dismissed.
The following properties are defined on the LOV link relation:- Source Attribute: DismissFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- smartActions
-
Parameters:
- ActivityAssigneeUniqID:
$request.path.ActivityAssigneeUniqID - ActivityNumber:
$request.path.ActivityNumber
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. - ActivityAssigneeUniqID:
Examples
The following example shows how to get an activity assignee by submitting a GET request on the REST resource using cURL.
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"ActivityId": 300100091331396
"AssigneeId": 100010034246683
"ActivityNumber": null
"AtkMessageId": 300100091339395
"ReminderDatetime": null
"ReminderPeriod": -1
"ResponseCode": "NOT_RESPONDED"
"SenderJobId": null
"ShowTimeAsCode": "TENTATIVE"
"ConflictId": 0
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-08-24T00:36:48-07:00"
"LastUpdateDate": "2016-08-24T02:26:54-07:00"
"LastUpdateLogin": "3ACD2BA10C14B0DEE053780CF10A305B"
"LastUpdatedBy": "SALES_ADMIN"
"UserLastUpdateDate": null
"PrimaryAssigneeFlag": "N"
"AssigneeName": "Waternoose,Henry"
"CorpCurrencyCode": "EUR"
"CurcyConvRateType": "Corporate"
"CurrencyCode": "EUR"
"Phone": null
"PrimaryEmail": null
"UserGuid": "961B262B131D0F14A47C50B2C312B90A"
"ActivityAssigneeId": 300100091331411
"UpgSourceObjectId": null
"UpgSourceObjectType": null
"RecurSeriesId": null
"ActivityFunctionCode": "APPOINTMENT"
"SortDate": "2014-05-25T23:00:00-07:00"
"StatusCode": null
"AttendeeFlag": true
"JobName": null
"PrimaryFormattedAddress": null
"DismissFlag": false
"AssigneePartyNumber": "100010034246683"
-
}